feature #4924 [swiftmailer] Document whitelist option to email redirect (TerjeBr)

This PR was submitted for the 2.6 branch but it was merged into the 2.3 branch instead (closes #4924).

Discussion
----------

[swiftmailer] Document whitelist option to email redirect

The redirectPlugin in switfmailer allows you to specify a white-list of regex's that matches email addresses that are still sent to, when redirecting all email to one address.

Code was added in PR [switfmailer/SwiftmailerBundle#19](symfony/swiftmailer-bundle#19)

Commits
-------

1448f58 More xml fixes
16907ed Xml changes and line-break changes
747199c Swiched mydomain and specialdomain
c35a26f Changes recommended by @cordoval
8c1da8a Changes recommended by @javierguiluz
4aa58a4 Changed line-breaks in text
217811d Added improvments from @wouterj
a4af6a0 fixed typo in "except"
6f64fdb Document whitelist option to email redirect

Author: weaverryan

cookbook/email/dev_environment.rst

@@ -11,7 +11,7 @@ can easily achieve this through configuration settings without having to
 make any changes to your application's code at all. There are two main
 choices when it comes to handling email during development: (a) disabling the
 sending of email altogether or (b) sending all email to a specific
-address.
+address (with optional exceptions).
 
 Disabling Sending
 -----------------
@@ -119,6 +119,67 @@ the replaced address, so you can still see who it would have been sent to.
     These are ``X-Swift-Cc`` and ``X-Swift-Bcc`` for the ``CC`` and ``BCC``
     addresses respectively.
 
+Sending to a Specified Address but with Exceptions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Suppose you want to have all email redirected to a specific address,
+(like in the above scenario to ``[email protected]``). But then you may want
+email sent to some specific email addresses to go through after all, and
+not be redirected (even if it is in the dev environment). This can be done
+by adding the ``delivery_whitelist`` option:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # app/config/config_dev.yml
+        swiftmailer:
+            delivery_address: [email protected]
+            delivery_whitelist:
+               # all email addresses matching this regex will *not* be
+               # redirected to [email protected]
+               - "/@specialdomain.com$/"
+
+               # all emails sent to [email protected] won't
+               # be redirected to [email protected] too
+               - "/^[email protected]$/"
+
+    .. code-block:: xml
+
+        <!-- app/config/config_dev.xml -->
+
+        <?xml version="1.0" charset="UTF-8" ?>
+        <container xmlns="http://symfony.com/schema/dic/services"
+            xmlns:swiftmailer="http://symfony.com/schema/dic/swiftmailer">
+
+        <swiftmailer:config delivery-address="[email protected]">
+            <!-- all email addresses matching this regex will *not* be redirected to [email protected] -->
+            <swiftmailer:delivery-whitelist-pattern>/@specialdomain.com$/</swiftmailer:delivery-whitelist-pattern>
+
+            <!-- all emails sent to [email protected] won't be redirected to [email protected] too -->
+            <swiftmailer:delivery-whitelist-pattern>/^[email protected]$/</swiftmailer:delivery-whitelist-pattern>
+        </swiftmailer:config>
+
+    .. code-block:: php
+
+        // app/config/config_dev.php
+        $container->loadFromExtension('swiftmailer', array(
+            'delivery_address'  => "[email protected]",
+            'delivery_whitelist' => array(
+                // all email addresses matching this regex will *not* be
+                // redirected to [email protected]
+                '/@specialdomain.com$/',
+
+                // all emails sent to [email protected] won't be
+                // redirected to [email protected] too
+                '/^[email protected]$/',
+            ),
+        ));
+
+In the above example all email messages will be redirected to ``[email protected]``,
+except messages sent to the ``[email protected]`` address or to any email
+address belonging to the domain ``specialdomain.com``, which will be delivered as normal.
+
 Viewing from the Web Debug Toolbar
 ----------------------------------