From 287b71fbe0fbf999e49c0f0aca9b427f3e507015 Mon Sep 17 00:00:00 2001 From: Romain Gautier Date: Fri, 17 Feb 2017 09:14:18 +0100 Subject: [PATCH 1/6] update swiftmailer reference --- reference/configuration/swiftmailer.rst | 42 +++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/reference/configuration/swiftmailer.rst b/reference/configuration/swiftmailer.rst index 1d6a1a81150..f16a0b87f7d 100644 --- a/reference/configuration/swiftmailer.rst +++ b/reference/configuration/swiftmailer.rst @@ -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,15 @@ Configuration * `disable_delivery`_ * `logging`_ +url +~~~ + +**type**: ``string`` + +The URL to configure swift mailer. + +Example: ``smtp://user:pass@host:port/?timeout=60&encryption=ssl&auth_mode=login&...`` + transport ~~~~~~~~~ @@ -79,6 +92,27 @@ port The port when using ``smtp`` as the transport. This defaults to 465 if encryption is ``ssl`` and 25 otherwise. +timeout +~~~~~~~ + +**type**: ``integer`` + +The timeout when using ``smtp`` as the transport + +source_ip +~~~~~~~~~ + +**type**: ``string`` + +The source IP when using ``smtp`` as the transport + +local_domain +~~~~~~~~~~~~ + +**type**: ``string`` + +The domain name to use in HELO command. + encryption ~~~~~~~~~~ @@ -191,6 +225,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``. + For details, see the :doc:`/configuration/external_parameters` article. + Full Default Configuration -------------------------- From 54ad41cb75098e35c141597f44263602af943728 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Sun, 19 Feb 2017 11:07:00 +0100 Subject: [PATCH 2/6] Minor tweaks --- reference/configuration/swiftmailer.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/reference/configuration/swiftmailer.rst b/reference/configuration/swiftmailer.rst index f16a0b87f7d..d8c2aed7c0d 100644 --- a/reference/configuration/swiftmailer.rst +++ b/reference/configuration/swiftmailer.rst @@ -46,7 +46,7 @@ url **type**: ``string`` -The URL to configure swift mailer. +The entire SwiftMailer configuration using a DSN-like URL format. Example: ``smtp://user:pass@host:port/?timeout=60&encryption=ssl&auth_mode=login&...`` @@ -97,21 +97,21 @@ timeout **type**: ``integer`` -The timeout when using ``smtp`` as the transport +The timeout in seconds when using ``smtp`` as the transport. source_ip ~~~~~~~~~ **type**: ``string`` -The source IP when using ``smtp`` as the transport +The source IP address when using ``smtp`` as the transport. local_domain ~~~~~~~~~~~~ **type**: ``string`` -The domain name to use in HELO command. +The domain name to use in ``HELO`` command. encryption ~~~~~~~~~~ From 635a0abea1d09bab8c8be1981dc417c55a1eb0f0 Mon Sep 17 00:00:00 2001 From: Romain Gautier Date: Thu, 23 Feb 2017 11:11:54 +0100 Subject: [PATCH 3/6] add mail transport as deprecated --- reference/configuration/swiftmailer.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/configuration/swiftmailer.rst b/reference/configuration/swiftmailer.rst index d8c2aed7c0d..b2ded55a23c 100644 --- a/reference/configuration/swiftmailer.rst +++ b/reference/configuration/swiftmailer.rst @@ -59,7 +59,7 @@ The exact transport method to use to deliver emails. Valid values are: * smtp * gmail (see :doc:`/email/gmail`) -* mail +* mail (deprecated in SwiftMailer since version 5.4.5) * sendmail * null (same as setting `disable_delivery`_ to ``true``) From ef7536c869713398a8b503ebe7f6d0c47f36a58f Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Mon, 13 Mar 2017 09:20:59 +0100 Subject: [PATCH 4/6] Added the missing "versionadded" directives --- reference/configuration/swiftmailer.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/reference/configuration/swiftmailer.rst b/reference/configuration/swiftmailer.rst index b2ded55a23c..1ee2f2ba9fc 100644 --- a/reference/configuration/swiftmailer.rst +++ b/reference/configuration/swiftmailer.rst @@ -46,6 +46,9 @@ 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. Example: ``smtp://user:pass@host:port/?timeout=60&encryption=ssl&auth_mode=login&...`` @@ -97,6 +100,9 @@ timeout **type**: ``integer`` +.. versionadded:: 2.4.2 + The ``url`` option was added in SwiftMailerBundle 2.4.2. + The timeout in seconds when using ``smtp`` as the transport. source_ip @@ -104,6 +110,9 @@ source_ip **type**: ``string`` +.. versionadded:: 2.4.2 + The ``url`` option was added in SwiftMailerBundle 2.4.2. + The source IP address when using ``smtp`` as the transport. local_domain @@ -111,6 +120,9 @@ local_domain **type**: ``string`` +.. versionadded:: 2.4.2 + The ``url`` option was added in SwiftMailerBundle 2.4.2. + The domain name to use in ``HELO`` command. encryption From 76ce6afff259ea4d2967cdafb3707353bfd46faf Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Mon, 13 Mar 2017 10:50:06 +0100 Subject: [PATCH 5/6] Fixed ... again ... the versionadded directives --- reference/configuration/swiftmailer.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/reference/configuration/swiftmailer.rst b/reference/configuration/swiftmailer.rst index 1ee2f2ba9fc..02cd8e70c8f 100644 --- a/reference/configuration/swiftmailer.rst +++ b/reference/configuration/swiftmailer.rst @@ -101,7 +101,7 @@ timeout **type**: ``integer`` .. versionadded:: 2.4.2 - The ``url`` option was added in SwiftMailerBundle 2.4.2. + The ``timeout`` option was added in SwiftMailerBundle 2.4.2. The timeout in seconds when using ``smtp`` as the transport. @@ -111,7 +111,7 @@ source_ip **type**: ``string`` .. versionadded:: 2.4.2 - The ``url`` option was added in SwiftMailerBundle 2.4.2. + The ``source_ip`` option was added in SwiftMailerBundle 2.4.2. The source IP address when using ``smtp`` as the transport. @@ -121,7 +121,7 @@ local_domain **type**: ``string`` .. versionadded:: 2.4.2 - The ``url`` option was added in SwiftMailerBundle 2.4.2. + The ``local_domain`` option was added in SwiftMailerBundle 2.4.2. The domain name to use in ``HELO`` command. From 6aa0117be6311fba0292f0745f19568fd6db523e Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Mon, 13 Mar 2017 11:31:34 +0100 Subject: [PATCH 6/6] Removed "encryption" and "auth_mode" from the list of %env()% compatible options --- reference/configuration/swiftmailer.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/reference/configuration/swiftmailer.rst b/reference/configuration/swiftmailer.rst index 02cd8e70c8f..87f20756b41 100644 --- a/reference/configuration/swiftmailer.rst +++ b/reference/configuration/swiftmailer.rst @@ -239,10 +239,9 @@ 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``. + The following options can be set via environment variables using the + ``%env()%`` syntax: ``url``, ``transport``, ``username``, ``password``, + ``host``, ``port``, ``timeout``, ``source_ip``, ``local_domain``. For details, see the :doc:`/configuration/external_parameters` article. Full Default Configuration