Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit c03d45a

Browse filesBrowse files
fabpotfabpot
committed
feature #43018 [Mailer] Adding support for TagHeader and MetadataHeader to the Sendgrid API transport (gnito-org)
This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [Mailer] Adding support for TagHeader and MetadataHeader to the Sendgrid API transport | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | None | License | MIT | Doc PR | symfony/symfony-docs#15816 I added support for tags and metadata to the Mailer Sendgrid API transport, in response to this discussion: #42481 The relevant Sendgrid API documentation is located at: - https://docs.sendgrid.com/for-developers/tracking-events/event#custom-arguments - https://docs.sendgrid.com/api-reference/mail-send/mail-send Commits ------- 58d0b5f [Mailer] Adding support for TagHeader and MetadataHeader to the Sendgrid API transport
2 parents f0ee163 + 58d0b5f commit c03d45a
Copy full SHA for c03d45a

File tree

3 files changed

+56
-2
lines changed
Filter options

3 files changed

+56
-2
lines changed

‎src/Symfony/Component/Mailer/Bridge/Sendgrid/CHANGELOG.md

Copy file name to clipboardExpand all lines: src/Symfony/Component/Mailer/Bridge/Sendgrid/CHANGELOG.md
+5Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
CHANGELOG
22
=========
33

4+
5.4
5+
---
6+
7+
* Add support for `TagHeader` and `MetadataHeader` to the Sendgrid API transport
8+
49
4.4.0
510
-----
611

‎src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/Transport/SendgridApiTransportTest.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/Transport/SendgridApiTransportTest.php
+26Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
use PHPUnit\Framework\TestCase;
1515
use Symfony\Component\Mailer\Bridge\Sendgrid\Transport\SendgridApiTransport;
1616
use Symfony\Component\Mailer\Envelope;
17+
use Symfony\Component\Mailer\Header\MetadataHeader;
18+
use Symfony\Component\Mailer\Header\TagHeader;
1719
use Symfony\Component\Mime\Address;
1820
use Symfony\Component\Mime\Email;
1921
use Symfony\Contracts\HttpClient\HttpClientInterface;
@@ -222,4 +224,28 @@ public function testEnvelopeSenderAndRecipients()
222224
$this->assertCount(1, $payload['personalizations'][0]['to']);
223225
$this->assertSame($envelopeTo, $payload['personalizations'][0]['to'][0]['email']);
224226
}
227+
228+
public function testTagAndMetadataHeaders()
229+
{
230+
$email = new Email();
231+
$email->getHeaders()->add(new TagHeader('category-one'));
232+
$email->getHeaders()->add(new MetadataHeader('Color', 'blue'));
233+
$email->getHeaders()->add(new MetadataHeader('Client-ID', '12345'));
234+
$envelope = new Envelope(new Address('alice@system.com'), [new Address('bob@system.com')]);
235+
236+
$transport = new SendgridApiTransport('ACCESS_KEY');
237+
$method = new \ReflectionMethod(SendgridApiTransport::class, 'getPayload');
238+
$method->setAccessible(true);
239+
$payload = $method->invoke($transport, $email, $envelope);
240+
241+
$this->assertArrayHasKey('categories', $payload);
242+
$this->assertArrayHasKey('custom_args', $payload['personalizations'][0]);
243+
244+
$this->assertCount(1, $payload['categories']);
245+
$this->assertCount(2, $payload['personalizations'][0]['custom_args']);
246+
247+
$this->assertSame(['category-one'], $payload['categories']);
248+
$this->assertSame('blue', $payload['personalizations'][0]['custom_args']['Color']);
249+
$this->assertSame('12345', $payload['personalizations'][0]['custom_args']['Client-ID']);
250+
}
225251
}

‎src/Symfony/Component/Mailer/Bridge/Sendgrid/Transport/SendgridApiTransport.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Mailer/Bridge/Sendgrid/Transport/SendgridApiTransport.php
+25-2Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
use Psr\Log\LoggerInterface;
1616
use Symfony\Component\Mailer\Envelope;
1717
use Symfony\Component\Mailer\Exception\HttpTransportException;
18+
use Symfony\Component\Mailer\Exception\TransportException;
19+
use Symfony\Component\Mailer\Header\MetadataHeader;
20+
use Symfony\Component\Mailer\Header\TagHeader;
1821
use Symfony\Component\Mailer\SentMessage;
1922
use Symfony\Component\Mailer\Transport\AbstractApiTransport;
2023
use Symfony\Component\Mime\Address;
@@ -111,7 +114,8 @@ private function getPayload(Email $email, Envelope $envelope): array
111114
$payload['reply_to'] = $emails[0];
112115
}
113116

114-
$payload['personalizations'][] = $personalization;
117+
$customArguments = [];
118+
$categories = [];
115119

116120
// these headers can't be overwritten according to Sendgrid docs
117121
// see https://sendgrid.api-docs.io/v3.0/mail-send/mail-send-errors#-Headers-Errors
@@ -121,9 +125,28 @@ private function getPayload(Email $email, Envelope $envelope): array
121125
continue;
122126
}
123127

124-
$payload['headers'][$name] = $header->getBodyAsString();
128+
if ($header instanceof TagHeader) {
129+
if (10 === \count($categories)) {
130+
throw new TransportException(sprintf('Too many "%s" instances present in the email headers. Sendgrid does not accept more than 10 categories on an email.', TagHeader::class));
131+
}
132+
$categories[] = mb_substr($header->getValue(), 0, 255);
133+
} elseif ($header instanceof MetadataHeader) {
134+
$customArguments[$header->getKey()] = $header->getValue();
135+
} else {
136+
$payload['headers'][$name] = $header->getBodyAsString();
137+
}
138+
}
139+
140+
if (\count($categories) > 0) {
141+
$payload['categories'] = $categories;
125142
}
126143

144+
if (\count($customArguments) > 0) {
145+
$personalization['custom_args'] = $customArguments;
146+
}
147+
148+
$payload['personalizations'][] = $personalization;
149+
127150
return $payload;
128151
}
129152

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.