From 95d472489346b3953a2de8ba94c5622fc27e9e59 Mon Sep 17 00:00:00 2001
From: Laurent VOULLEMIER <laurent.voullemier@gmail.com>
Date: Mon, 17 Aug 2020 09:08:14 +0200
Subject: [PATCH] Add mailer in framework config reference

---
 mailer.rst                            |   2 +
 reference/configuration/framework.rst | 100 +++++++++++++++++++++++++-
 2 files changed, 101 insertions(+), 1 deletion(-)

diff --git a/mailer.rst b/mailer.rst
index 229964ce30e..c4ad3e254a8 100644
--- a/mailer.rst
+++ b/mailer.rst
@@ -825,6 +825,8 @@ and it will select the appropriate certificate depending on the ``To`` option::
     $firstEncryptedEmail = $encrypter->encrypt($firstEmail);
     $secondEncryptedEmail = $encrypter->encrypt($secondEmail);
 
+.. _multiple-email-transports:
+
 Multiple Email Transports
 -------------------------
 
diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst
index 456fd5298a4..3e647d50e5d 100644
--- a/reference/configuration/framework.rst
+++ b/reference/configuration/framework.rst
@@ -151,6 +151,15 @@ Configuration
 
     * :ref:`name <reference-lock-resources-name>`
 
+* `mailer`_
+
+  * :ref:`dsn <mailer-dsn>`
+  * `transports`_
+  * `envelope`_
+
+    * `sender`_
+    * `recipients`_
+
 * `php_errors`_
 
   * `log`_
@@ -159,7 +168,7 @@ Configuration
 * `profiler`_
 
   * `collect`_
-  * `dsn`_
+  * :ref:`dsn <profiler-dsn>`
   * :ref:`enabled <reference-profiler-enabled>`
   * `only_exceptions`_
   * `only_master_requests`_
@@ -1075,6 +1084,8 @@ only_master_requests
 When this is set to ``true``, the profiler will only be enabled on the master
 requests (and not on the subrequests).
 
+.. _profiler-dsn:
+
 dsn
 ...
 
@@ -2932,6 +2943,93 @@ Name of the lock you want to create.
             decorates: lock.invoice.store
             arguments: ['@lock.invoice.retry_till_save.store.inner', 100, 50]
 
+mailer
+~~~~~~
+
+.. _mailer-dsn:
+
+dsn
+...
+
+**type**: ``string``
+
+The DSN used by the mailer. When several DSN may be used, use `transports` (see below) instead.
+
+transports
+..........
+
+**type**: ``array``
+
+A :ref:`list of DSN <multiple-email-transports>` that can be used by the mailer. A transport name is the key and the dsn is the value.
+
+envelope
+........
+
+sender
+""""""
+
+**type**: ``string``
+
+Sender used by the `Mailer`. Keep in mind that this setting override a sender set in the code.
+
+recipients
+""""""""""
+
+**type**: ``array``
+
+Recipients used by the `Mailer`. Keep in mind that this setting override recipients set in the code.
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # config/packages/mailer.yaml
+        framework:
+            mailer:
+                dsn: 'smtp://localhost:25'
+                envelope:
+                    recipients: ['admin@symfony.com', 'lead@symfony.com']
+
+    .. code-block:: xml
+
+        <!-- config/packages/mailer.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:framework="http://symfony.com/schema/dic/symfony"
+            xsi:schemaLocation="http://symfony.com/schema/dic/services
+                https://symfony.com/schema/dic/services/services-1.0.xsd
+                http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
+
+            <framework:config>
+                <framework:mailer dsn="smtp://localhost:25">
+                    <framework:envelope>
+                        <framework:recipients>admin@symfony.com</framework:recipients>
+                        <framework:recipients>lead@symfony.com</framework:recipients>
+                    </framework:envelope>
+                </framework:mailer>
+            </framework:config>
+        </container>
+
+    .. code-block:: php
+
+        // config/packages/mailer.php
+        namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+        return static function (ContainerConfigurator $containerConfigurator): void {
+            $containerConfigurator->extension('framework', [
+                'mailer' => [
+                    'dsn' => 'smtp://localhost:25',
+                    'envelope' => [
+                        'recipients' => [
+                            'admin@symfony.com',
+                            'lead@symfony.com'
+                        ]
+                    ]
+                ]
+            ]);
+        };
+
 workflows
 ~~~~~~~~~
 

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>pFad - Phonifier reborn</title>
<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
</head>
<body>
<h1>Pfad - The Proxy pFad of &#169; 2024 Garber Painting. All rights reserved.</h1>


<!-- Disclaimer -->
<p>Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.</p>
<br>
<p>Alternative Proxies:</p><p><a href="http://rainy.clevelandohioweatherforecast.com/php-proxy/index.php?q=https://patch-diff.githubusercontent.com/raw/symfony/symfony-docs/pull/14087.patch" target="_blank">Alternative Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony-docs/pull/14087.patch" target="_blank">pFad Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v3index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony-docs/pull/14087.patch" target="_blank">pFad v3 Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v4index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony-docs/pull/14087.patch" target="_blank">pFad v4 Proxy</a></p></body>
</html>