From 19d9617cae4caa2a4f510f27e034950e25bb4178 Mon Sep 17 00:00:00 2001
From: Jordan de Laune <jordan@kadence.co>
Date: Thu, 18 Aug 2022 09:58:17 +0100
Subject: [PATCH] Update example to use Address format

It seems strange to me that the example for the From headers uses the full Address format, whereas the sender envelope does not.

I believe it is possible to use it here, so thought I would expand on the example to show how you can set both the display name and email address when configuring the sender envelope globally.
---
 mailer.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/mailer.rst b/mailer.rst
index e109c581adc..66f5b7a2d07 100644
--- a/mailer.rst
+++ b/mailer.rst
@@ -551,7 +551,7 @@ and headers.
         framework:
             mailer:
                 envelope:
-                    sender: 'fabien@example.com'
+                    sender: 'Fabien <fabien@example.com>'
                     recipients: ['foo@example.com', 'bar@example.com']
                 headers:
                     From: 'Fabien <fabien@example.com>'
@@ -573,7 +573,7 @@ and headers.
             <framework:config>
                 <framework:mailer>
                     <framework:envelope>
-                        <framework:sender>fabien@example.com</framework:sender>
+                        <framework:sender>Fabien &lt;fabien@example.com&gt;</framework:sender>
                         <framework:recipients>foo@example.com</framework:recipients>
                         <framework:recipients>bar@example.com</framework:recipients>
                     </framework:envelope>
@@ -593,7 +593,7 @@ and headers.
             $mailer = $framework->mailer();
             $mailer
                 ->envelope()
-                    ->sender('fabien@example.com')
+                    ->sender('Fabien <fabien@example.com>')
                     ->recipients(['foo@example.com', 'bar@example.com'])
             ;