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 1 commit
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
42 changes: 42 additions & 0 deletions 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,15 @@ 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``

The URL to configure swift mailer.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Swiftmailer

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"The URL" doesn't look precise enough to me. What about "The URL describing the mail server to connect with"?


Example: ``smtp://user:pass@host:port/?timeout=60&encryption=ssl&auth_mode=login&...``

transport
~~~~~~~~~

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

Expand Down Expand Up @@ -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``.
Copy link
Contributor

Choose a reason for hiding this comment

The 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
--------------------------

Expand Down