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

Author: lyrixx

CHANGELOG.md

@@ -6,6 +6,7 @@ CHANGELOG
 
  * Dispatch Postmark's "406 - Inactive recipient" API error code as a `PostmarkDeliveryEvent` instead of throwing an exception
  * Add DSN param `auto_tls` to disable automatic STARTTLS
+ * Add support for allowing some users even if `recipients` is defined in `EnvelopeListener`
 
 7.0
 ---

EventListener/EnvelopeListener.php

@@ -20,6 +20,7 @@
  * Manipulates the Envelope of a Message.
  *
  * @author Fabien Potencier <[email protected]>
+ * @author Grégoire Pineau <[email protected]>
  */
 class EnvelopeListener implements EventSubscriberInterface
 {
@@ -32,9 +33,13 @@ class EnvelopeListener implements EventSubscriberInterface
 
     /**
      * @param array<Address|string> $recipients
+     * @param string[]              $allowedRecipients An array of regex to match the allowed recipients
      */
-    public function __construct(Address|string|null $sender = null, ?array $recipients = null)
-    {
+    public function __construct(
+        Address|string|null $sender = null,
+        ?array $recipients = null,
+        private array $allowedRecipients = [],
+    ) {
         if (null !== $sender) {
             $this->sender = Address::create($sender);
         }
@@ -57,7 +62,27 @@ public function onMessage(MessageEvent $event): void
         }
 
         if ($this->recipients) {
-            $event->getEnvelope()->setRecipients($this->recipients);
+            $recipients = $this->recipients;
+            if ($this->allowedRecipients) {
+                foreach ($event->getEnvelope()->getRecipients() as $recipient) {
+                    foreach ($this->allowedRecipients as $allowedRecipient) {
+                        if (!preg_match('{\A'.$allowedRecipient.'\z}', $recipient->getAddress())) {
+                            continue;
+                        }
+                        // dedup
+                        foreach ($recipients as $r) {
+                            if ($r->getName() === $recipient->getName() && $r->getAddress() === $recipient->getAddress()) {
+                                continue 2;
+                            }
+                        }
+
+                        $recipients[] = $recipient;
+                        continue 2;
+                    }
+                }
+            }
+
+            $event->getEnvelope()->setRecipients($recipients);
         }
     }
 

Tests/EventListener/EnvelopeListenerTest.php

@@ -0,0 +1,47 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Mailer\Tests\EventListener;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Mailer\Envelope;
+use Symfony\Component\Mailer\Event\MessageEvent;
+use Symfony\Component\Mailer\EventListener\EnvelopeListener;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\RawMessage;
+
+class EnvelopeListenerTest extends TestCase
+{
+    /**
+     * @dataProvider provideRecipientsTests
+     */
+    public function testRecipients(array $expected, ?array $recipients = null, array $allowedRecipients = [])
+    {
+        $listener = new EnvelopeListener(null, $recipients, $allowedRecipients);
+        $message = new RawMessage('message');
+        $envelope = new Envelope(new Address('[email protected]'), [new Address('[email protected]'), new Address('[email protected]')]);
+        $event = new MessageEvent($message, $envelope, 'default');
+
+        $listener->onMessage($event);
+
+        $recipients = array_map(fn (Address $a): string => $a->getAddress(), $event->getEnvelope()->getRecipients());
+        $this->assertSame($expected, $recipients);
+    }
+
+    public static function provideRecipientsTests(): iterable
+    {
+        yield [['[email protected]', '[email protected]'], null, []];
+        yield [['[email protected]'], ['[email protected]'], []];
+        yield [['[email protected]', '[email protected]'], ['[email protected]'], ['.*@example\.com']];
+        yield [['[email protected]', '[email protected]', '[email protected]'], ['[email protected]'], ['.*@example\.com', '.*@symfony\.com']];
+        yield [['[email protected]', '[email protected]'], ['[email protected]'], ['.*@example\.com', '.*@symfony\.com']];
+    }
+}