Merge pull request symfony#3464 from xabbuh/issue-3440

weaverryan · weaverryan · commit b804087b84c9 · 2014-02-01T09:48:26.000-08:00
document the ability to configure more than one mailer at the same time
diff --git a/reference/configuration/swiftmailer.rst b/reference/configuration/swiftmailer.rst
@@ -11,6 +11,9 @@ options, see `Full Default Configuration`_
 The ``swiftmailer`` key configures Symfony's integration with Swift Mailer,
 which is responsible for creating and delivering email messages.
 
+The following section lists all options that are available to configure a
+mailer. It is also possible to configure several mailers (see `Using Multiple Mailers`_).
+
 Configuration
 -------------
 
@@ -220,3 +223,65 @@ Full Default Configuration
                 threshold="99"
             />
         </swiftmailer:config>
+
+Using Multiple Mailers
+----------------------
+
+You can configure multiple mailers by grouping them under the ``mailers``
+key (the default mailer is identified by the ``default_mailer`` option):
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        swiftmailer:
+            default_mailer: second_mailer
+            mailers:
+                first_mailer:
+                    # ...
+                second_mailer:
+                    # ...
+
+    .. code-block:: xml
+
+        <?xml version="1.0" encoding="UTF-8" ?>
+        <container xmlns="http://symfony.com/schema/dic/services"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xmlns:swiftmailer="http://symfony.com/schema/dic/swiftmailer"
+            xsi:schemaLocation="http://symfony.com/schema/dic/services
+                http://symfony.com/schema/dic/services/services-1.0.xsd
+                http://symfony.com/schema/dic/swiftmailer
+                http://symfony.com/schema/dic/swiftmailer/swiftmailer-1.0.xsd"
+        >
+            <swiftmailer:config default-mailer="second_mailer">
+                <swiftmailer:mailer name="first_mailer"/>
+                <swiftmailer:mailer name="second_mailer"/>
+            </swiftmailer:config>
+        </container>
+
+    .. code-block:: php
+
+        $container->loadFromExtension('swiftmailer', array(
+            'default_mailer' => 'second_mailer',
+            'mailers' => array(
+                'first_mailer' => array(
+                    // ...
+                ),
+                'second_mailer' => array(
+                    // ...
+                ),
+            ),
+        ));
+
+Each mailer is registered as a service::
+
+    // ...
+
+    // returns the first mailer
+    $container->get('swiftmailer.mailer.first_mailer');
+
+    // also returns the second mailer since it is the default mailer
+    $container->get('swiftmailer.mailer');
+
+    // returns the second mailer
+    $container->get('swiftmailer.mailer.second_mailer');
