Skip to content

[Mailer] fixed destination override by envelope in amazon api transport #35042

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.

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

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@
namespace Symfony\Component\Mailer\Bridge\Amazon\Tests\Transport;

use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpClient\MockHttpClient;
use Symfony\Component\HttpClient\Response\MockResponse;
use Symfony\Component\Mailer\Bridge\Amazon\Transport\SesApiTransport;
use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Email;

class SesApiTransportTest extends TestCase
{
Expand Down Expand Up @@ -45,4 +50,83 @@ public function getTransportData()
],
];
}

public function testSendEmail()
{
$awsApiCallback = function ($method, $url, $options) {
$requestParts = [];
parse_str($options['body'], $requestParts);

$this->assertEquals('POST', $method);
$this->assertEquals('https://email.eu-west-1.amazonaws.com/', $url);

$this->assertEquals($requestParts['Source'], 'sender@example.tld');
$this->assertArrayNotHasKey('Destinations.member', $requestParts);

return new MockResponse($this->createMockAwsSendRawEmailResponse());
};

$httpClient = new MockHttpClient($awsApiCallback);
$transport = new SesApiTransport('ACCESS_KEY', 'SECRET_KEY', 'eu-west-1', $httpClient);

$email = (new Email())
->from('sender@example.tld')
->to('recipient-to@example.tld')
->subject('Test Mail')
->text('Text content of the test mail')
->html('<p>HTML content of the test mail</p>');

$transport->send($email);
}

public function testSendEmailWithEnvelopeOverride()
{
$awsApiCallback = function ($method, $url, $options) {
$requestParts = [];
parse_str($options['body'], $requestParts);

$this->assertEquals('POST', $method);
$this->assertEquals('https://email.eu-west-1.amazonaws.com/', $url);

$this->assertEquals($requestParts['Source'], 'envelope-sender@example.tld');
$this->assertArrayHasKey('Destinations_member', $requestParts);
$this->assertEquals($requestParts['Destinations_member'], [
'envelope-recipient-1@example.tld',
'envelope-recipient-2@example.tld',
]);

return new MockResponse($this->createMockAwsSendRawEmailResponse());
};

$httpClient = new MockHttpClient($awsApiCallback);
$transport = new SesApiTransport('ACCESS_KEY', 'SECRET_KEY', 'eu-west-1', $httpClient);

$email = (new Email())
->from('sender@example.tld')
->to('recipient-to@example.tld')
->subject('Test Mail')
->text('Text content of the test mail')
->html('<p>HTML content of the test mail</p>');

$envelope = new Envelope(Address::create('envelope-sender@example.tld'), [
Address::create('envelope-recipient-1@example.tld'),
Address::create('envelope-recipient-2@example.tld'),
]);

$transport->send($email, $envelope);
}

private function createMockAwsSendRawEmailResponse(): string
{
return <<<XML
<SendRawEmailResponse xmlns="http://ses.amazonaws.com/doc/2010-12-01/">
<SendRawEmailResult>
<MessageId>0102016f1eb7661b-4294e7da-5d64-45c2-8998-e8ade5468d95-000000</MessageId>
</SendRawEmailResult>
<ResponseMetadata>
<RequestId>dc4fb17f-0320-428b-8c03-62f9ec9b98ba</RequestId>
</ResponseMetadata>
</SendRawEmailResponse>
XML;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SentMessage;
use Symfony\Component\Mailer\Transport\AbstractApiTransport;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Email;
use Symfony\Component\Mime\Header\MailboxListHeader;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;
Expand Down Expand Up @@ -87,33 +89,42 @@ private function getSignature(string $string): string

private function getPayload(Email $email, Envelope $envelope): array
{
if ($email->getAttachments()) {
return [
'Action' => 'SendRawEmail',
'RawMessage.Data' => base64_encode($email->toString()),
];
}

$payload = [
'Action' => 'SendEmail',
'Destination.ToAddresses.member' => $this->stringifyAddresses($this->getRecipients($email, $envelope)),
'Message.Subject.Data' => $email->getSubject(),
'Action' => 'SendRawEmail',
'RawMessage.Data' => base64_encode($email->toString()),
'Source' => $envelope->getSender()->toString(),
];

if ($emails = $email->getCc()) {
$payload['Destination.CcAddresses.member'] = $this->stringifyAddresses($emails);
}
if ($emails = $email->getBcc()) {
$payload['Destination.BccAddresses.member'] = $this->stringifyAddresses($emails);
}
if ($email->getTextBody()) {
$payload['Message.Body.Text.Data'] = $email->getTextBody();
}
if ($email->getHtmlBody()) {
$payload['Message.Body.Html.Data'] = $email->getHtmlBody();
$headerRecipients = $this->getRecipientAddressesFromHeaders($email);
$envelopeRecipients = array_map(static function (Address $recipient) {
return $recipient->getAddress();
}, $envelope->getRecipients());
$requiresDestinations = \count(array_diff($headerRecipients, $envelopeRecipients)) > 0;

if ($requiresDestinations) {
$payload['Destinations.member'] = $this->stringifyAddresses($envelope->getRecipients());
}

return $payload;
}

/**
* @return string[]
*/
private function getRecipientAddressesFromHeaders(Email $email): array
{
$headers = $email->getHeaders();

$recipients = [];
foreach (['to', 'cc', 'bcc'] as $name) {
foreach ($headers->all($name) as $header) {
/* @var MailboxListHeader $header */
foreach ($header->getAddresses() as $address) {
$recipients[] = $address->getAddress();
}
}
}

return $recipients;
}
}