Skip to content

[Mailer] [Mailgun] Allow multiple TagHeaders with MailgunApiTransport #44137

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
Dec 11, 2021
Merged

[Mailer] [Mailgun] Allow multiple TagHeaders with MailgunApiTransport #44137

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/Mailgun/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
CHANGELOG
=========

6.1
---

* Allow multiple `TagHeaders` with `MailgunApiTransport`

5.2
---

Expand Down
39 changes: 37 additions & 2 deletions src/Symfony/Component/Mailer/Bridge/Mailgun/Tests/Transport/MailgunApiTransportTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,38 @@ public function testSend()
$this->assertSame('foobar', $message->getMessageId());
}

public function testSendWithMultipleTagHeaders()
{
$client = new MockHttpClient(function (string $method, string $url, array $options): ResponseInterface {
$content = '';
while ($chunk = $options['body']()) {
$content .= $chunk;
}

$this->assertStringContainsString("Content-Disposition: form-data; name=\"o:tag\"\r\n\r\npassword-reset\r\n", $content);
$this->assertStringContainsString("Content-Disposition: form-data; name=\"o:tag\"\r\n\r\nproduct-name\r\n", $content);

return new MockResponse(json_encode(['id' => 'foobar2']), [
'http_code' => 200,
]);
});
$transport = new MailgunApiTransport('ACCESS_KEY', 'symfony', 'us-east-1', $client);

$mail = new Email();
$mail->subject('Hello!')
->to(new Address('saif.gmati@symfony.com', 'Saif Eddin'))
->from(new Address('fabpot@symfony.com', 'Fabien'))
->text('Hello There!');

$mail->getHeaders()
->add(new TagHeader('password-reset'))
->add(new TagHeader('product-name'));

$message = $transport->send($mail);

$this->assertSame('foobar2', $message->getMessageId());
}

public function testSendThrowsForErrorResponse()
{
$client = new MockHttpClient(function (string $method, string $url, array $options): ResponseInterface {
Expand Down Expand Up @@ -216,6 +248,7 @@ public function testTagAndMetadataHeaders()
$email->getHeaders()->addTextHeader('h:X-Mailgun-Variables', $json);
$email->getHeaders()->addTextHeader('Custom-Header', 'value');
$email->getHeaders()->add(new TagHeader('password-reset'));
$email->getHeaders()->add(new TagHeader('product-name'));
$email->getHeaders()->add(new MetadataHeader('Color', 'blue'));
$email->getHeaders()->add(new MetadataHeader('Client-ID', '12345'));
$envelope = new Envelope(new Address('alice@system.com'), [new Address('bob@system.com')]);
Expand All @@ -228,8 +261,10 @@ public function testTagAndMetadataHeaders()
$this->assertEquals($json, $payload['h:x-mailgun-variables']);
$this->assertArrayHasKey('h:custom-header', $payload);
$this->assertEquals('value', $payload['h:custom-header']);
$this->assertArrayHasKey('o:tag', $payload);
$this->assertSame('password-reset', $payload['o:tag']);
$this->assertArrayHasKey(0, $payload);
$this->assertArrayHasKey(1, $payload);
$this->assertSame('password-reset', $payload[0]['o:tag']);
$this->assertSame('product-name', $payload[1]['o:tag']);
$this->assertArrayHasKey('v:Color', $payload);
$this->assertSame('blue', $payload['v:Color']);
$this->assertArrayHasKey('v:Client-ID', $payload);
Expand Down
8 changes: 6 additions & 2 deletions src/Symfony/Component/Mailer/Bridge/Mailgun/Tests/Transport/MailgunHttpTransportTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ public function testTagAndMetadataHeaders()
$email = new Email();
$email->getHeaders()->addTextHeader('foo', 'bar');
$email->getHeaders()->add(new TagHeader('password-reset'));
$email->getHeaders()->add(new TagHeader('product-name'));
$email->getHeaders()->add(new MetadataHeader('Color', 'blue'));
$email->getHeaders()->add(new MetadataHeader('Client-ID', '12345'));

Expand All @@ -130,9 +131,12 @@ public function testTagAndMetadataHeaders()
$method->setAccessible(true);
$method->invoke($transport, $email);

$this->assertCount(3, $email->getHeaders()->toArray());
$this->assertCount(4, $email->getHeaders()->toArray());
$this->assertSame('foo: bar', $email->getHeaders()->get('foo')->toString());
$this->assertSame('X-Mailgun-Tag: password-reset', $email->getHeaders()->get('X-Mailgun-Tag')->toString());
$this->assertCount(2, $email->getHeaders()->all('X-Mailgun-Tag'));
$tagHeaders = iterator_to_array($email->getHeaders()->all('X-Mailgun-Tag'));
$this->assertSame('X-Mailgun-Tag: password-reset', $tagHeaders[0]->toString());
$this->assertSame('X-Mailgun-Tag: product-name', $tagHeaders[1]->toString());
$this->assertSame('X-Mailgun-Variables: '.json_encode(['Color' => 'blue', 'Client-ID' => '12345']), $email->getHeaders()->get('X-Mailgun-Variables')->toString());
}
}
2 changes: 1 addition & 1 deletion src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunApiTransport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ private function getPayload(Email $email, Envelope $envelope): array
}

if ($header instanceof TagHeader) {
$payload['o:tag'] = $header->getValue();
$payload[] = ['o:tag' => $header->getValue()];

continue;
}
Expand Down