[FrameworkBundle][Mailer] Add a way to configure some email headers from semantic configuration

Author: fabpot

DependencyInjection/Configuration.php

@@ -1492,6 +1492,7 @@ private function addMailerSection(ArrayNodeDefinition $rootNode)
                         ->thenInvalid('"dsn" and "transports" cannot be used together.')
                     ->end()
                     ->fixXmlConfig('transport')
+                    ->fixXmlConfig('header')
                     ->children()
                         ->scalarNode('message_bus')->defaultNull()->info('The message bus to use. Defaults to the default bus if the Messenger component is installed.')->end()
                         ->scalarNode('dsn')->defaultNull()->end()
@@ -1515,6 +1516,20 @@ private function addMailerSection(ArrayNodeDefinition $rootNode)
                                 ->end()
                             ->end()
                         ->end()
+                        ->arrayNode('headers')
+                            ->normalizeKeys(false)
+                            ->useAttributeAsKey('name')
+                            ->prototype('array')
+                                ->normalizeKeys(false)
+                                ->beforeNormalization()
+                                    ->ifTrue(function ($v) { return !\is_array($v) || array_keys($v) !== ['value']; })
+                                    ->then(function ($v) { return ['value' => $v]; })
+                                ->end()
+                                ->children()
+                                    ->variableNode('value')->end()
+                                ->end()
+                            ->end()
+                        ->end()
                     ->end()
                 ->end()
             ->end()

DependencyInjection/FrameworkExtension.php

@@ -89,6 +89,7 @@
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Messenger\Transport\TransportFactoryInterface;
 use Symfony\Component\Messenger\Transport\TransportInterface;
+use Symfony\Component\Mime\Header\Headers;
 use Symfony\Component\Mime\MimeTypeGuesserInterface;
 use Symfony\Component\Mime\MimeTypes;
 use Symfony\Component\Notifier\Bridge\Firebase\FirebaseTransportFactory;
@@ -1986,12 +1987,24 @@ private function registerMailerConfiguration(array $config, ContainerBuilder $co
             }
         }
 
-        $recipients = $config['envelope']['recipients'] ?? null;
-        $sender = $config['envelope']['sender'] ?? null;
-
         $envelopeListener = $container->getDefinition('mailer.envelope_listener');
-        $envelopeListener->setArgument(0, $sender);
-        $envelopeListener->setArgument(1, $recipients);
+        $envelopeListener->setArgument(0, $config['envelope']['sender'] ?? null);
+        $envelopeListener->setArgument(1, $config['envelope']['recipients'] ?? null);
+
+        if ($config['headers']) {
+            $headers = new Definition(Headers::class);
+            foreach ($config['headers'] as $name => $data) {
+                $value = $data['value'];
+                if (\in_array(strtolower($name), ['from', 'to', 'cc', 'bcc', 'reply-to'])) {
+                    $value = (array) $value;
+                }
+                $headers->addMethodCall('addHeader', [$name, $value]);
+            }
+            $messageListener = $container->getDefinition('mailer.message_listener');
+            $messageListener->setArgument(0, $headers);
+        } else {
+            $container->removeDefinition('mailer.message_listener');
+        }
     }
 
     private function registerNotifierConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader)

Resources/config/mailer.xml

@@ -39,6 +39,11 @@
             <tag name="kernel.event_subscriber"/>
         </service>
 
+        <service id="mailer.message_listener" class="Symfony\Component\Mailer\EventListener\MessageListener">
+            <argument /> <!-- headers -->
+            <tag name="kernel.event_subscriber"/>
+        </service>
+
         <service id="mailer.logger_message_listener" class="Symfony\Component\Mailer\EventListener\MessageLoggerListener">
             <tag name="kernel.event_subscriber"/>
         </service>

Resources/config/schema/symfony-1.0.xsd

@@ -560,14 +560,19 @@
     <xsd:complexType name="mailer">
         <xsd:sequence>
             <xsd:element name="envelope" type="mailer_envelope" minOccurs="0" maxOccurs="1" />
+            <xsd:element name="header" type="header" minOccurs="0" maxOccurs="unbounded" />
         </xsd:sequence>
         <xsd:attribute name="dsn" type="xsd:string" />
         <xsd:attribute name="message-bus" type="xsd:string" />
     </xsd:complexType>
 
+    <xsd:complexType name="header" mixed="true">
+        <xsd:attribute name="name" type="xsd:string" use="required" />
+    </xsd:complexType>
+
     <xsd:complexType name="mailer_envelope">
         <xsd:sequence>
-            <xsd:element name="sender" type="xsd:string" />
+            <xsd:element name="sender" type="xsd:string" minOccurs="0" maxOccurs="1" />
             <xsd:element name="recipients" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
         </xsd:sequence>
     </xsd:complexType>

Tests/DependencyInjection/ConfigurationTest.php

@@ -493,6 +493,7 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
                 'transports' => [],
                 'enabled' => !class_exists(FullStack::class) && class_exists(Mailer::class),
                 'message_bus' => null,
+                'headers' => [],
             ],
             'notifier' => [
                 'enabled' => !class_exists(FullStack::class) && class_exists(Notifier::class),

Tests/DependencyInjection/Fixtures/php/mailer.php

@@ -7,5 +7,10 @@
             'sender' => 'sender@example.org',
             'recipients' => ['redirected@example.org', 'redirected1@example.org'],
         ],
+        'headers' => [
+            'from' => 'from@example.org',
+            'bcc' => ['bcc1@example.org', 'bcc2@example.org'],
+            'foo' => 'bar',
+        ],
     ],
 ]);

Tests/DependencyInjection/Fixtures/xml/mailer.xml

@@ -13,6 +13,9 @@
                 <framework:recipients>redirected@example.org</framework:recipients>
                 <framework:recipients>redirected1@example.org</framework:recipients>
             </framework:envelope>
+            <framework:header name="from">from@example.org</framework:header>
+            <framework:header name="bcc">bcc1@example.org</framework:header>
+            <framework:header name="foo">bar</framework:header>
         </framework:mailer>
     </framework:config>
 </container>

Tests/DependencyInjection/Fixtures/yml/mailer.yml

@@ -6,3 +6,7 @@ framework:
             recipients:
                 - redirected@example.org
                 - redirected1@example.org
+        headers:
+            from: from@example.org
+            bcc: [bcc1@example.org, bcc2@example.org]
+            foo: bar

Tests/DependencyInjection/FrameworkExtensionTest.php

@@ -1435,6 +1435,11 @@ public function testMailer(): void
         $this->assertSame('sender@example.org', $l->getArgument(0));
         $this->assertSame(['redirected@example.org', 'redirected1@example.org'], $l->getArgument(1));
         $this->assertEquals(new Reference('messenger.default_bus', ContainerInterface::NULL_ON_INVALID_REFERENCE), $container->getDefinition('mailer.mailer')->getArgument(1));
+
+        $this->assertTrue($container->hasDefinition('mailer.message_listener'));
+        $l = $container->getDefinition('mailer.message_listener');
+        $h = $l->getArgument(0);
+        $this->assertCount(3, $h->getMethodCalls());
     }
 
     public function testMailerWithDisabledMessageBus(): void

composer.json

@@ -45,7 +45,7 @@
         "symfony/expression-language": "^4.4|^5.0",
         "symfony/http-client": "^4.4|^5.0",
         "symfony/lock": "^4.4|^5.0",
-        "symfony/mailer": "^4.4|^5.0",
+        "symfony/mailer": "^5.2",
         "symfony/messenger": "^4.4|^5.0",
         "symfony/mime": "^4.4|^5.0",
         "symfony/process": "^4.4|^5.0",
@@ -79,7 +79,7 @@
         "symfony/http-client": "<4.4",
         "symfony/form": "<4.4",
         "symfony/lock": "<4.4",
-        "symfony/mailer": "<4.4",
+        "symfony/mailer": "<5.2",
         "symfony/messenger": "<4.4",
         "symfony/mime": "<4.4",
         "symfony/property-info": "<4.4",