[11.x] Add ListManagementOptions in SES mail transport (#50660)

* Add ListManagementOptions in SES mail transport

* formatting

* formatting

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: arifszn

src/Illuminate/Mail/Transport/SesTransport.php

@@ -50,6 +50,10 @@ protected function doSend(SentMessage $message): void
         $options = $this->options;
 
         if ($message->getOriginalMessage() instanceof Message) {
+            if ($listManagementOptions = $this->listManagementOptions($message)) {
+                $options['ListManagementOptions'] = $listManagementOptions;
+            }
+
             foreach ($message->getOriginalMessage()->getHeaders()->all() as $header) {
                 if ($header instanceof MetadataHeader) {
                     $options['Tags'][] = ['Name' => $header->getKey(), 'Value' => $header->getValue()];
@@ -89,6 +93,21 @@ protected function doSend(SentMessage $message): void
         $message->getOriginalMessage()->getHeaders()->addHeader('X-SES-Message-ID', $messageId);
     }
 
+    /**
+     * Extract the SES list managenent options, if applicable.
+     *
+     * @param  \Illuminate\Mail\SentMessage  $message
+     * @return array|null
+     */
+    protected function listManagementOptions(SentMessage $message)
+    {
+        if ($header = $message->getOriginalMessage()->getHeaders()->get('X-SES-LIST-MANAGEMENT-OPTIONS')) {
+            if (preg_match("/^(contactListName=)*(?<ContactListName>[^;]+)(;\s?topicName=(?<TopicName>.+))?$/ix", $header->getBodyAsString(), $listManagementOptions)) {
+                return array_filter($listManagementOptions, fn ($e) => in_array($e, ['ContactListName', 'TopicName']), ARRAY_FILTER_USE_KEY);
+            }
+        }
+    }
+
     /**
      * Get the Amazon SES client for the SesTransport instance.
      *

src/Illuminate/Mail/Transport/SesV2Transport.php

@@ -50,6 +50,10 @@ protected function doSend(SentMessage $message): void
         $options = $this->options;
 
         if ($message->getOriginalMessage() instanceof Message) {
+            if ($listManagementOptions = $this->listManagementOptions($message)) {
+                $options['ListManagementOptions'] = $listManagementOptions;
+            }
+
             foreach ($message->getOriginalMessage()->getHeaders()->all() as $header) {
                 if ($header instanceof MetadataHeader) {
                     $options['Tags'][] = ['Name' => $header->getKey(), 'Value' => $header->getValue()];
@@ -93,6 +97,21 @@ protected function doSend(SentMessage $message): void
         $message->getOriginalMessage()->getHeaders()->addHeader('X-SES-Message-ID', $messageId);
     }
 
+    /**
+     * Extract the SES list managenent options, if applicable.
+     *
+     * @param  \Illuminate\Mail\SentMessage  $message
+     * @return array|null
+     */
+    protected function listManagementOptions(SentMessage $message)
+    {
+        if ($header = $message->getOriginalMessage()->getHeaders()->get('X-SES-LIST-MANAGEMENT-OPTIONS')) {
+            if (preg_match("/^(contactListName=)*(?<ContactListName>[^;]+)(;\s?topicName=(?<TopicName>.+))?$/ix", $header->getBodyAsString(), $listManagementOptions)) {
+                return array_filter($listManagementOptions, fn ($e) => in_array($e, ['ContactListName', 'TopicName']), ARRAY_FILTER_USE_KEY);
+            }
+        }
+    }
+
     /**
      * Get the Amazon SES V2 client for the SesV2Transport instance.
      *

tests/Mail/MailSesTransportTest.php

@@ -62,6 +62,7 @@ public function testSend()
         $message->bcc('[email protected]');
         $message->replyTo(new Address('[email protected]', 'Taylor Otwell'));
         $message->getHeaders()->add(new MetadataHeader('FooTag', 'TagValue'));
+        $message->getHeaders()->addTextHeader('X-Ses-List-Management-Options', 'contactListName=TestList;topicName=TestTopic');
 
         $client = m::mock(SesClient::class);
         $sesResult = m::mock();
@@ -73,6 +74,7 @@ public function testSend()
             ->with(m::on(function ($arg) {
                 return $arg['Source'] === '[email protected]' &&
                     $arg['Destinations'] === ['[email protected]', '[email protected]'] &&
+                    $arg['ListManagementOptions'] === ['ContactListName' => 'TestList', 'TopicName' => 'TestTopic'] &&
                     $arg['Tags'] === [['Name' => 'FooTag', 'Value' => 'TagValue']] &&
                     strpos($arg['RawMessage']['Data'], 'Reply-To: Taylor Otwell <[email protected]>') !== false;
             }))

tests/Mail/MailSesV2TransportTest.php

@@ -62,6 +62,7 @@ public function testSend()
         $message->bcc('[email protected]');
         $message->replyTo(new Address('[email protected]', 'Taylor Otwell'));
         $message->getHeaders()->add(new MetadataHeader('FooTag', 'TagValue'));
+        $message->getHeaders()->addTextHeader('X-SES-LIST-MANAGEMENT-OPTIONS', 'contactListName=TestList;topicName=TestTopic');
 
         $client = m::mock(SesV2Client::class);
         $sesResult = m::mock();
@@ -73,6 +74,7 @@ public function testSend()
             ->with(m::on(function ($arg) {
                 return $arg['Source'] === '[email protected]' &&
                     $arg['Destination']['ToAddresses'] === ['[email protected]', '[email protected]'] &&
+                    $arg['ListManagementOptions'] === ['ContactListName' => 'TestList', 'TopicName' => 'TestTopic'] &&
                     $arg['Tags'] === [['Name' => 'FooTag', 'Value' => 'TagValue']] &&
                     strpos($arg['Content']['Raw']['Data'], 'Reply-To: Taylor Otwell <[email protected]>') !== false;
             }))