Skip to content
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.

Sign up for GitHub

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

[Reference] Add missing option delivery_whitelist #4925

Closed
wants to merge 1 commit into from
Closed

[Reference] Add missing option delivery_whitelist #4925

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions reference/configuration/swiftmailer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Configuration
* `threshold`_
* `sleep`_
* `delivery_address`_
* `delivery_whitelist`_
* `disable_delivery`_
* `logging`_

Expand Down Expand Up @@ -156,6 +157,16 @@ emails sent during development go to a single account.
This uses ``Swift_Plugins_RedirectingPlugin``. Original recipients are available
on the ``X-Swift-To``, ``X-Swift-Cc`` and ``X-Swift-Bcc`` headers.

delivery_whitelist
~~~~~~~~~~~~~~~~~~

**type**: ``array``

Used in combination with ``delivery_address``. If set, send email as normal to
addresses that match with the values in the list. All addresses not matching will
be sent to ``delivery_address`` as is the normal behavior when setting a
``delivery_address``.
Copy link
Member

Choose a reason for hiding this comment

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

We should include a link to the now-merged new section about this: http://symfony.com/doc/current/cookbook/email/dev_environment.html#sending-to-a-specified-address-but-with-exceptions

And with this link, we can make the description here ever shorter - perhaps just:

Used in combination with ``deliver_address``. If set, emails matching this pattern will
be delivered like normal, instead of being sent to `delivery_address`. For details, see
LINK...

We'll need to add a new anchor link above that section (e.g. .. _cookbook-emails-delivery_whitelist) so we can link to it.

Thanks!


disable_delivery
~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -195,6 +206,7 @@ Full default Configuration
threshold: 99
sleep: 0
delivery_address: ~
delivery_whitelist: ~
disable_delivery: ~
logging: "%kernel.debug%"

Expand Down