Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Mailer] [Amazon] Add support for X-SES-LIST-MANAGEMENT-OPTIONS header #53901

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 17, 2024
Merged

[Mailer] [Amazon] Add support for X-SES-LIST-MANAGEMENT-OPTIONS header #53901

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Amazon/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
CHANGELOG
=========

7.1
---

* Add support for `X-SES-LIST-MANAGEMENT-OPTIONS`

6.1
---

Expand Down
2 changes: 2 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Amazon/Tests/Transport/SesApiAsyncAwsTransportTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ public function testSend()
$this->assertSame('aws-source-arn', $content['FromEmailAddressIdentityArn']);
$this->assertSame('[email protected]', $content['FeedbackForwardingEmailAddress']);
$this->assertSame([['Name' => 'tagName1', 'Value' => 'tag Value1'], ['Name' => 'tagName2', 'Value' => 'tag Value2']], $content['EmailTags']);
$this->assertSame(['ContactListName' => 'TestContactList', 'TopicName' => 'TestNewsletter'], $content['ListManagementOptions']);

$json = '{"MessageId": "foobar"}';

Expand All @@ -113,6 +114,7 @@ public function testSend()

$mail->getHeaders()->addTextHeader('X-SES-CONFIGURATION-SET', 'aws-configuration-set-name');
$mail->getHeaders()->addTextHeader('X-SES-SOURCE-ARN', 'aws-source-arn');
$mail->getHeaders()->addTextHeader('X-SES-LIST-MANAGEMENT-OPTIONS', 'contactListName=TestContactList;topicName=TestNewsletter');
$mail->getHeaders()->add(new MetadataHeader('tagName1', 'tag Value1'));
$mail->getHeaders()->add(new MetadataHeader('tagName2', 'tag Value2'));

Expand Down
2 changes: 2 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Amazon/Tests/Transport/SesHttpAsyncAwsTransportTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ public function testSend()
$this->assertSame('aws-configuration-set-name', $body['ConfigurationSetName']);
$this->assertSame('aws-source-arn', $body['FromEmailAddressIdentityArn']);
$this->assertSame([['Name' => 'tagName1', 'Value' => 'tag Value1'], ['Name' => 'tagName2', 'Value' => 'tag Value2']], $body['EmailTags']);
$this->assertSame(['ContactListName' => 'TestContactList', 'TopicName' => 'TestNewsletter'], $body['ListManagementOptions']);

$json = '{"MessageId": "foobar"}';

Expand All @@ -106,6 +107,7 @@ public function testSend()

$mail->getHeaders()->addTextHeader('X-SES-CONFIGURATION-SET', 'aws-configuration-set-name');
$mail->getHeaders()->addTextHeader('X-SES-SOURCE-ARN', 'aws-source-arn');
$mail->getHeaders()->addTextHeader('X-SES-LIST-MANAGEMENT-OPTIONS', 'contactListName=TestContactList;topicName=TestNewsletter');
$mail->getHeaders()->add(new MetadataHeader('tagName1', 'tag Value1'));
$mail->getHeaders()->add(new MetadataHeader('tagName2', 'tag Value2'));

Expand Down
5 changes: 5 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Amazon/Transport/SesApiAsyncAwsTransport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,11 @@ protected function getRequest(SentMessage $message): SendEmailRequest
if ($header = $email->getHeaders()->get('X-SES-SOURCE-ARN')) {
$request['FromEmailAddressIdentityArn'] = $header->getBodyAsString();
}
if ($header = $email->getHeaders()->get('X-SES-LIST-MANAGEMENT-OPTIONS')) {
if (preg_match("/^(contactListName=)*(?<ContactListName>[^;]+)(;\s?topicName=(?<TopicName>.+))?$/ix", $header->getBodyAsString(), $listManagementOptions)) {
$request['ListManagementOptions'] = array_filter($listManagementOptions, fn ($e) => \in_array($e, ['ContactListName', 'TopicName']), \ARRAY_FILTER_USE_KEY);
}
}
if ($email->getReturnPath()) {
$request['FeedbackForwardingEmailAddress'] = $email->getReturnPath()->toString();
}
Expand Down
24 changes: 14 additions & 10 deletions src/Symfony/Component/Mailer/Bridge/Amazon/Transport/SesHttpAsyncAwsTransport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,16 +78,20 @@ protected function getRequest(SentMessage $message): SendEmailRequest
],
];

if (($message->getOriginalMessage() instanceof Message)
&& $configurationSetHeader = $message->getOriginalMessage()->getHeaders()->get('X-SES-CONFIGURATION-SET')) {
$request['ConfigurationSetName'] = $configurationSetHeader->getBodyAsString();
}
if (($message->getOriginalMessage() instanceof Message)
&& $sourceArnHeader = $message->getOriginalMessage()->getHeaders()->get('X-SES-SOURCE-ARN')) {
$request['FromEmailAddressIdentityArn'] = $sourceArnHeader->getBodyAsString();
}
if ($message->getOriginalMessage() instanceof Message) {
foreach ($message->getOriginalMessage()->getHeaders()->all() as $header) {
$originalMessage = $message->getOriginalMessage();
if ($originalMessage instanceof Message) {
if ($configurationSetHeader = $message->getOriginalMessage()->getHeaders()->get('X-SES-CONFIGURATION-SET')) {
$request['ConfigurationSetName'] = $configurationSetHeader->getBodyAsString();
}
if ($sourceArnHeader = $message->getOriginalMessage()->getHeaders()->get('X-SES-SOURCE-ARN')) {
$request['FromEmailAddressIdentityArn'] = $sourceArnHeader->getBodyAsString();
}
if ($header = $message->getOriginalMessage()->getHeaders()->get('X-SES-LIST-MANAGEMENT-OPTIONS')) {
if (preg_match("/^(contactListName=)*(?<ContactListName>[^;]+)(;\s?topicName=(?<TopicName>.+))?$/ix", $header->getBodyAsString(), $listManagementOptions)) {
$request['ListManagementOptions'] = array_filter($listManagementOptions, fn ($e) => \in_array($e, ['ContactListName', 'TopicName']), \ARRAY_FILTER_USE_KEY);
}
}
foreach ($originalMessage->getHeaders()->all() as $header) {
if ($header instanceof MetadataHeader) {
$request['EmailTags'][] = ['Name' => $header->getKey(), 'Value' => $header->getValue()];
}
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Mailer/Bridge/Amazon/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
],
"require": {
"php": ">=8.2",
"async-aws/ses": "^1.0",
"async-aws/ses": "^1.3",
"symfony/mailer": "^6.4|^7.0"
},
"require-dev": {
Expand Down