Skip to content

[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

Merged
merged 6 commits into from
Apr 28, 2017
Merged
Changes from all commits
Commits
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
55 changes: 54 additions & 1 deletion reference/configuration/swiftmailer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`_
Expand All @@ -37,6 +41,18 @@ Configuration
* `disable_delivery`_
* `logging`_

url
~~~

Copy link
Contributor

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)

**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&...``

transport
~~~~~~~~~

Expand All @@ -46,7 +62,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``)

Expand Down Expand Up @@ -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
~~~~~~~~~~

Expand Down Expand Up @@ -191,6 +237,13 @@ 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 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
--------------------------

Expand Down