-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[SwiftMailer] Update future reference #7510
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.
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
Changes from 5 commits
287b71f
54ad41c
635a0ab
ef7536c
76ce6af
6aa0117
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,11 +18,15 @@ a mailer. It is also possible to configure several mailers (see | |
Configuration | ||
------------- | ||
|
||
* `url`_ | ||
* `transport`_ | ||
* `username`_ | ||
* `password`_ | ||
* `host`_ | ||
* `port`_ | ||
* `timeout`_ | ||
* `source_ip`_ | ||
* `local_domain`_ | ||
* `encryption`_ | ||
* `auth_mode`_ | ||
* `spool`_ | ||
|
@@ -37,6 +41,18 @@ Configuration | |
* `disable_delivery`_ | ||
* `logging`_ | ||
|
||
url | ||
~~~ | ||
|
||
**type**: ``string`` | ||
|
||
.. versionadded:: 2.4.2 | ||
The ``url`` option was added in SwiftMailerBundle 2.4.2. | ||
|
||
The entire SwiftMailer configuration using a DSN-like URL format. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "using" => "uses" There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think "using" is correct here. We're not saying that Swift "uses" this ... but that the "url" option is all the Swift config using a DSN format. |
||
|
||
Example: ``smtp://user:pass@host:port/?timeout=60&encryption=ssl&auth_mode=login&...`` | ||
|
||
transport | ||
~~~~~~~~~ | ||
|
||
|
@@ -46,7 +62,7 @@ The exact transport method to use to deliver emails. Valid values are: | |
|
||
* smtp | ||
* gmail (see :doc:`/email/gmail`) | ||
* mail (deprecated in SwiftMailer since version 5.4.5) | ||
* sendmail | ||
* null (same as setting `disable_delivery`_ to ``true``) | ||
|
||
|
@@ -79,6 +95,36 @@ port | |
The port when using ``smtp`` as the transport. This defaults to 465 if encryption | ||
is ``ssl`` and 25 otherwise. | ||
|
||
timeout | ||
~~~~~~~ | ||
|
||
**type**: ``integer`` | ||
|
||
.. versionadded:: 2.4.2 | ||
The ``timeout`` option was added in SwiftMailerBundle 2.4.2. | ||
|
||
The timeout in seconds when using ``smtp`` as the transport. | ||
|
||
source_ip | ||
~~~~~~~~~ | ||
|
||
**type**: ``string`` | ||
|
||
.. versionadded:: 2.4.2 | ||
The ``source_ip`` option was added in SwiftMailerBundle 2.4.2. | ||
|
||
The source IP address when using ``smtp`` as the transport. | ||
|
||
local_domain | ||
~~~~~~~~~~~~ | ||
|
||
**type**: ``string`` | ||
|
||
.. versionadded:: 2.4.2 | ||
The ``local_domain`` option was added in SwiftMailerBundle 2.4.2. | ||
|
||
The domain name to use in ``HELO`` command. | ||
|
||
encryption | ||
~~~~~~~~~~ | ||
|
||
|
@@ -191,6 +237,14 @@ logging | |
If true, Symfony's data collector will be activated for Swift Mailer and | ||
the information will be available in the profiler. | ||
|
||
.. tip:: | ||
|
||
The following configuration options are compatible with ``%env()%`` parameters: | ||
``url``, ``transport``, ``username``, ``password``, ``host``, | ||
``port``, ``timeout``, ``source_ip``, ``local_domain``, | ||
``encryption``, ``auth_mode``. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Considering symfony/swiftmailer-bundle#159 (comment), we should remove these two parameters for now, wdyt? |
||
For details, see the :doc:`/configuration/external_parameters` article. | ||
|
||
Full Default Configuration | ||
-------------------------- | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing version added? (same for other options below)