Skip to content

[Mailer] Document new Mailer transport options #13911

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
merged 1 commit into from
Jul 30, 2021
Merged

[Mailer] Document new Mailer transport options #13911

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
51 changes: 51 additions & 0 deletions mailer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,57 @@ the application or when using a self-signed certificate::

The ``verify_peer`` option was introduced in Symfony 5.1.

Other Options
~~~~~~~~~~~~~

``command``
Command to be executed by ``sendmail`` transport::

$dsn = 'sendmail://default?command=/usr/sbin/sendmail%20-oi%20-t'

.. versionadded:: 5.2

This option was introduced in Symfony 5.2.


``local_domain``
The domain name to use in ``HELO`` command::

$dsn = 'smtps://smtp.example.com?local_domain=example.org'

.. versionadded:: 5.2

This option was introduced in Symfony 5.2.

``restart_threshold``
The maximum number of messages to send before re-starting the transport. It
can be used together with ``restart_threshold_sleep``::

$dsn = 'smtps://smtp.example.com?restart_threshold=10&restart_threshold_sleep=1'

.. versionadded:: 5.2

This option was introduced in Symfony 5.2.

``restart_threshold_sleep``
The number of seconds to sleep between stopping and re-starting the transport.
It's commont to combine it with ``restart_threshold``::

$dsn = 'smtps://smtp.example.com?restart_threshold=10&restart_threshold_sleep=1'

.. versionadded:: 5.2

This option was introduced in Symfony 5.2.

``ping_threshold``
The minimum number of seconds between two messages required to ping the server::

$dsn = 'smtps://smtp.example.com?ping_threshold=200'

.. versionadded:: 5.2

This option was introduced in Symfony 5.2.

Creating & Sending Messages
---------------------------

Expand Down