Skip to content

Commit 5788863

Browse files
committed
minor #7510 [SwiftMailer] Update future reference (mykiwi, javiereguiluz)
This PR was merged into the master branch. Discussion ---------- [SwiftMailer] Update future reference - [x] Require symfony/swiftmailer-bundle#159 Commits ------- 6aa0117 Removed "encryption" and "auth_mode" from the list of %env()% compatible options 76ce6af Fixed ... again ... the versionadded directives ef7536c Added the missing "versionadded" directives 635a0ab add mail transport as deprecated 54ad41c Minor tweaks 287b71f update swiftmailer reference
2 parents 5d5f2ff + 6aa0117 commit 5788863

File tree

1 file changed

+54
-1
lines changed

1 file changed

+54
-1
lines changed

reference/configuration/swiftmailer.rst

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,15 @@ a mailer. It is also possible to configure several mailers (see
1818
Configuration
1919
-------------
2020

21+
* `url`_
2122
* `transport`_
2223
* `username`_
2324
* `password`_
2425
* `host`_
2526
* `port`_
27+
* `timeout`_
28+
* `source_ip`_
29+
* `local_domain`_
2630
* `encryption`_
2731
* `auth_mode`_
2832
* `spool`_
@@ -37,6 +41,18 @@ Configuration
3741
* `disable_delivery`_
3842
* `logging`_
3943

44+
url
45+
~~~
46+
47+
**type**: ``string``
48+
49+
.. versionadded:: 2.4.2
50+
The ``url`` option was added in SwiftMailerBundle 2.4.2.
51+
52+
The entire SwiftMailer configuration using a DSN-like URL format.
53+
54+
Example: ``smtp://user:pass@host:port/?timeout=60&encryption=ssl&auth_mode=login&...``
55+
4056
transport
4157
~~~~~~~~~
4258

@@ -46,7 +62,7 @@ The exact transport method to use to deliver emails. Valid values are:
4662

4763
* smtp
4864
* gmail (see :doc:`/email/gmail`)
49-
* mail
65+
* mail (deprecated in SwiftMailer since version 5.4.5)
5066
* sendmail
5167
* null (same as setting `disable_delivery`_ to ``true``)
5268

@@ -79,6 +95,36 @@ port
7995
The port when using ``smtp`` as the transport. This defaults to 465 if encryption
8096
is ``ssl`` and 25 otherwise.
8197

98+
timeout
99+
~~~~~~~
100+
101+
**type**: ``integer``
102+
103+
.. versionadded:: 2.4.2
104+
The ``timeout`` option was added in SwiftMailerBundle 2.4.2.
105+
106+
The timeout in seconds when using ``smtp`` as the transport.
107+
108+
source_ip
109+
~~~~~~~~~
110+
111+
**type**: ``string``
112+
113+
.. versionadded:: 2.4.2
114+
The ``source_ip`` option was added in SwiftMailerBundle 2.4.2.
115+
116+
The source IP address when using ``smtp`` as the transport.
117+
118+
local_domain
119+
~~~~~~~~~~~~
120+
121+
**type**: ``string``
122+
123+
.. versionadded:: 2.4.2
124+
The ``local_domain`` option was added in SwiftMailerBundle 2.4.2.
125+
126+
The domain name to use in ``HELO`` command.
127+
82128
encryption
83129
~~~~~~~~~~
84130

@@ -191,6 +237,13 @@ logging
191237
If true, Symfony's data collector will be activated for Swift Mailer and
192238
the information will be available in the profiler.
193239

240+
.. tip::
241+
242+
The following options can be set via environment variables using the
243+
``%env()%`` syntax: ``url``, ``transport``, ``username``, ``password``,
244+
``host``, ``port``, ``timeout``, ``source_ip``, ``local_domain``.
245+
For details, see the :doc:`/configuration/external_parameters` article.
246+
194247
Full Default Configuration
195248
--------------------------
196249

0 commit comments

Comments
 (0)