[Mailer] Add support for allowing some users even if recipients is defined in EnvelopeListener

lyrixx · lyrixx · commit bc336a14228d · 2024-04-08T15:46:48.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,8 @@ CHANGELOG
  * Add `secrets:reveal` command
  * Add `rate_limiter` option to `http_client.default_options` and `http_client.scoped_clients`
  * Attach the workflow's configuration to the `workflow` tag
+ * Add the `allowed_recipients` option for mailer to allow some users to receive
+   emails even if `recipients` is defined.
 
 7.0
 ---
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -2117,12 +2117,23 @@ private function addMailerSection(ArrayNodeDefinition $rootNode, callable $enabl
                         ->arrayNode('envelope')
                             ->info('Mailer Envelope configuration')
                             ->fixXmlConfig('recipient')
+                            ->fixXmlConfig('allowed_recipient')
                             ->children()
                                 ->scalarNode('sender')->end()
                                 ->arrayNode('recipients')
                                     ->performNoDeepMerging()
                                     ->beforeNormalization()
-                                    ->ifArray()
+                                        ->ifArray()
+                                        ->then(fn ($v) => array_filter(array_values($v)))
+                                    ->end()
+                                    ->prototype('scalar')->end()
+                                ->end()
+                                ->arrayNode('allowed_recipients')
+                                    ->info('A list of regular expressions that allow recipients when "recipients" option is defined.')
+                                    ->example(['.*@example\.com'])
+                                    ->performNoDeepMerging()
+                                    ->beforeNormalization()
+                                        ->ifArray()
                                         ->then(fn ($v) => array_filter(array_values($v)))
                                     ->end()
                                     ->prototype('scalar')->end()
diff --git a/DependencyInjection/FrameworkExtension.php b/DependencyInjection/FrameworkExtension.php
@@ -2647,6 +2647,7 @@ private function registerMailerConfiguration(array $config, ContainerBuilder $co
         $envelopeListener = $container->getDefinition('mailer.envelope_listener');
         $envelopeListener->setArgument(0, $config['envelope']['sender'] ?? null);
         $envelopeListener->setArgument(1, $config['envelope']['recipients'] ?? null);
+        $envelopeListener->setArgument(2, $config['envelope']['allowed_recipients'] ?? []);
 
         if ($config['headers']) {
             $headers = new Definition(Headers::class);
diff --git a/Resources/config/schema/symfony-1.0.xsd b/Resources/config/schema/symfony-1.0.xsd
@@ -764,6 +764,7 @@
         <xsd:sequence>
             <xsd:element name="sender" type="xsd:string" minOccurs="0" maxOccurs="1" />
             <xsd:element name="recipient" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
+            <xsd:element name="allowed-recipient" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
         </xsd:sequence>
     </xsd:complexType>
 
diff --git a/Tests/DependencyInjection/Fixtures/php/mailer_with_dsn.php b/Tests/DependencyInjection/Fixtures/php/mailer_with_dsn.php
@@ -13,6 +13,7 @@
             'envelope' => [
                 'sender' => 'sender@example.org',
                 'recipients' => ['redirected@example.org'],
+                'allowed_recipients' => ['foobar@example\.org'],
             ],
             'headers' => [
                 'from' => 'from@example.org',
diff --git a/Tests/DependencyInjection/Fixtures/php/mailer_with_transports.php b/Tests/DependencyInjection/Fixtures/php/mailer_with_transports.php
@@ -16,6 +16,7 @@
             'envelope' => [
                 'sender' => 'sender@example.org',
                 'recipients' => ['redirected@example.org', 'redirected1@example.org'],
+                'allowed_recipients' => ['foobar@example\.org', '.*@example\.com'],
             ],
             'headers' => [
                 'from' => 'from@example.org',
diff --git a/Tests/DependencyInjection/Fixtures/xml/mailer_with_dsn.xml b/Tests/DependencyInjection/Fixtures/xml/mailer_with_dsn.xml
@@ -13,6 +13,7 @@
             <framework:envelope>
                 <framework:sender>sender@example.org</framework:sender>
                 <framework:recipient>redirected@example.org</framework:recipient>
+                <framework:allowed-recipient>foobar@example\.org</framework:allowed-recipient>
             </framework:envelope>
             <framework:header name="from">from@example.org</framework:header>
             <framework:header name="bcc">bcc1@example.org</framework:header>
diff --git a/Tests/DependencyInjection/Fixtures/xml/mailer_with_transports.xml b/Tests/DependencyInjection/Fixtures/xml/mailer_with_transports.xml
@@ -16,6 +16,8 @@
                 <framework:sender>sender@example.org</framework:sender>
                 <framework:recipient>redirected@example.org</framework:recipient>
                 <framework:recipient>redirected1@example.org</framework:recipient>
+                <framework:allowed-recipient>foobar@example\.org</framework:allowed-recipient>
+                <framework:allowed-recipient>.*@example\.com</framework:allowed-recipient>
             </framework:envelope>
             <framework:header name="from">from@example.org</framework:header>
             <framework:header name="bcc">bcc1@example.org</framework:header>
diff --git a/Tests/DependencyInjection/Fixtures/yml/mailer_with_dsn.yml b/Tests/DependencyInjection/Fixtures/yml/mailer_with_dsn.yml
@@ -10,6 +10,8 @@ framework:
             sender: sender@example.org
             recipients:
                 - redirected@example.org
+            allowed_recipients:
+                - foobar@example\.org
         headers:
             from: from@example.org
             bcc: [bcc1@example.org, bcc2@example.org]
diff --git a/Tests/DependencyInjection/Fixtures/yml/mailer_with_transports.yml b/Tests/DependencyInjection/Fixtures/yml/mailer_with_transports.yml
@@ -13,6 +13,9 @@ framework:
             recipients:
                 - redirected@example.org
                 - redirected1@example.org
+            allowed_recipients:
+                - foobar@example\.org
+                - .*@example\.com
         headers:
             from: from@example.org
             bcc: [bcc1@example.org, bcc2@example.org]
diff --git a/Tests/DependencyInjection/FrameworkExtensionTestCase.php b/Tests/DependencyInjection/FrameworkExtensionTestCase.php
@@ -2043,6 +2043,7 @@ public static function provideMailer(): iterable
             'mailer_with_dsn',
             ['main' => 'smtp://example.com'],
             ['redirected@example.org'],
+            ['foobar@example\.org'],
         ];
         yield [
             'mailer_with_transports',
@@ -2051,13 +2052,14 @@ public static function provideMailer(): iterable
                 'transport2' => 'smtp://example2.com',
             ],
             ['redirected@example.org', 'redirected1@example.org'],
+            ['foobar@example\.org', '.*@example\.com'],
         ];
     }
 
     /**
      * @dataProvider provideMailer
      */
-    public function testMailer(string $configFile, array $expectedTransports, array $expectedRecipients)
+    public function testMailer(string $configFile, array $expectedTransports, array $expectedRecipients, array $expectedAllowedRecipients)
     {
         $container = $this->createContainerFromFile($configFile);
 
@@ -2070,6 +2072,7 @@ public function testMailer(string $configFile, array $expectedTransports, array
         $l = $container->getDefinition('mailer.envelope_listener');
         $this->assertSame('sender@example.org', $l->getArgument(0));
         $this->assertSame($expectedRecipients, $l->getArgument(1));
+        $this->assertSame($expectedAllowedRecipients, $l->getArgument(2));
         $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'));

-Original file line number
+Diff line change
             'envelope' => [
                 'sender' => '[email protected]',
                 'recipients' => ['[email protected]'],
 +                'allowed_recipients' => ['foobar@example\.org'],
             ],
             'headers' => [
                 'from' => '[email protected]',