Skip to content

[Mailer] Document the usage of default_socket_timeout in SMTP #13225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HeahDude merged 1 commit into from
Feb 23, 2020
Merged

[Mailer] Document the usage of default_socket_timeout in SMTP #13225

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions components/mailer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,16 @@ For third-party providers, refer to the following table:
Sendgrid sendgrid+smtp://apikey:KEY@default n/a sendgrid+api://KEY@default
==================== ========================================== =========================================== ========================================

.. note::

When using SMTP, the default timeout for sending a message before throwing an
exception is the value defined in the `default_socket_timeout`_ PHP.ini option.

.. versionadded:: 5.1

The usage of ``default_socket_timeout`` as the default timeout was
introduced in Symfony 5.1.

Instead of choosing a specific protocol, you can also let Symfony pick the
best one by omitting it from the scheme: for instance, ``mailgun://KEY:DOMAIN@default``
is equivalent to ``mailgun+https://KEY:DOMAIN@default``.
Expand Down Expand Up @@ -213,3 +223,4 @@ To learn more about how to use the mailer component, refer to the

.. _`high availability`: https://en.wikipedia.org/wiki/High_availability
.. _`load balancing`: https://en.wikipedia.org/wiki/Load_balancing_(computing)
.. _`default_socket_timeout`: https://www.php.net/manual/en/filesystem.configuration.php#ini.default-socket-timeout