-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[Mailer] Add Resend bridge #53554
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
Merged
Merged
[Mailer] Add Resend bridge #53554
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| /Tests export-ignore | ||
| /phpunit.xml.dist export-ignore | ||
| /.gitattributes export-ignore | ||
| /.gitignore export-ignore |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| vendor/ | ||
| composer.lock | ||
| phpunit.xml |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| CHANGELOG | ||
| ========= | ||
|
|
||
| 7.1 | ||
| --- | ||
|
|
||
| * Add the bridge |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| Copyright (c) 2024-present Fabien Potencier | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is furnished | ||
| to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| THE SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| Resend Bridge | ||
| ============ | ||
|
|
||
| Provides Resend integration for Symfony Mailer. | ||
|
|
||
| Configuration example: | ||
|
|
||
| ```env | ||
| # SMTP | ||
| MAILER_DSN=resend+smtp://resend:API_KEY@default | ||
|
|
||
| # API | ||
| MAILER_DSN=resend+api://API_KEY@default | ||
| ``` | ||
|
|
||
| where: | ||
| - `API_KEY` is your Resend API Key | ||
|
|
||
| Resources | ||
| --------- | ||
|
|
||
| * [Contributing](https://symfony.com/doc/current/contributing/index.html) | ||
| * [Report issues](https://github.com/symfony/symfony/issues) and | ||
| [send Pull Requests](https://github.com/symfony/symfony/pulls) | ||
| in the [main Symfony repository](https://github.com/symfony/symfony) | ||
53 changes: 53 additions & 0 deletions
53
src/Symfony/Component/Mailer/Bridge/Resend/RemoteEvent/ResendPayloadConverter.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <[email protected]> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Mailer\Bridge\Resend\RemoteEvent; | ||
|
|
||
| use Symfony\Component\RemoteEvent\Event\Mailer\AbstractMailerEvent; | ||
| use Symfony\Component\RemoteEvent\Event\Mailer\MailerDeliveryEvent; | ||
| use Symfony\Component\RemoteEvent\Event\Mailer\MailerEngagementEvent; | ||
| use Symfony\Component\RemoteEvent\Exception\ParseException; | ||
| use Symfony\Component\RemoteEvent\PayloadConverterInterface; | ||
|
|
||
| final class ResendPayloadConverter implements PayloadConverterInterface | ||
| { | ||
| public function convert(array $payload): AbstractMailerEvent | ||
| { | ||
| if (\in_array($payload['type'], ['email.sent', 'email.delivered', 'email.delivery_delayed', 'email.bounced'], true)) { | ||
| $name = match ($payload['type']) { | ||
| 'email.sent' => MailerDeliveryEvent::RECEIVED, | ||
| 'email.delivered' => MailerDeliveryEvent::DELIVERED, | ||
| 'email.delivery_delayed' => MailerDeliveryEvent::DEFERRED, | ||
| 'email.bounced' => MailerDeliveryEvent::BOUNCE, | ||
| }; | ||
|
|
||
| $event = new MailerDeliveryEvent($name, $payload['data']['email_id'], $payload); | ||
| } else { | ||
| $name = match ($payload['type']) { | ||
| 'email.clicked' => MailerEngagementEvent::CLICK, | ||
| 'email.opened' => MailerEngagementEvent::OPEN, | ||
| 'email.complained' => MailerEngagementEvent::SPAM, | ||
| default => throw new ParseException(sprintf('Unsupported event "%s".', $payload['type'])), | ||
| }; | ||
| $event = new MailerEngagementEvent($name, $payload['data']['email_id'], $payload); | ||
| } | ||
|
|
||
| if (!$date = \DateTimeImmutable::createFromFormat('Y-m-d\TH:i:s.uP', $payload['created_at'])) { | ||
| throw new ParseException(sprintf('Invalid date "%s".', $payload['created_at'])); | ||
| } | ||
|
|
||
| $event->setDate($date); | ||
| $event->setRecipientEmail(implode(', ', $payload['data']['to'])); | ||
| $event->setMetadata($payload['data']); | ||
|
|
||
| return $event; | ||
| } | ||
| } |
179 changes: 179 additions & 0 deletions
179
src/Symfony/Component/Mailer/Bridge/Resend/Tests/ResendApiTransportTest.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <[email protected]> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Mailer\Bridge\Resend\Tests; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Component\HttpClient\MockHttpClient; | ||
| use Symfony\Component\HttpClient\Response\JsonMockResponse; | ||
| use Symfony\Component\Mailer\Bridge\Resend\Transport\ResendApiTransport; | ||
| use Symfony\Component\Mailer\Envelope; | ||
| use Symfony\Component\Mailer\Exception\HttpTransportException; | ||
| use Symfony\Component\Mailer\Header\MetadataHeader; | ||
| use Symfony\Component\Mailer\Header\TagHeader; | ||
| use Symfony\Component\Mime\Address; | ||
| use Symfony\Component\Mime\Email; | ||
| use Symfony\Component\Mime\Part\DataPart; | ||
| use Symfony\Contracts\HttpClient\ResponseInterface; | ||
|
|
||
| class ResendApiTransportTest extends TestCase | ||
| { | ||
| /** | ||
| * @dataProvider getTransportData | ||
| */ | ||
| public function testToString(ResendApiTransport $transport, string $expected) | ||
| { | ||
| $this->assertSame($expected, (string) $transport); | ||
| } | ||
|
|
||
| public static function getTransportData(): \Generator | ||
| { | ||
| yield [ | ||
| new ResendApiTransport('ACCESS_KEY'), | ||
| 'resend+api://api.resend.com', | ||
| ]; | ||
|
|
||
| yield [ | ||
| (new ResendApiTransport('ACCESS_KEY'))->setHost('example.com'), | ||
| 'resend+api://example.com', | ||
| ]; | ||
|
|
||
| yield [ | ||
| (new ResendApiTransport('ACCESS_KEY'))->setHost('example.com')->setPort(99), | ||
| 'resend+api://example.com:99', | ||
| ]; | ||
| } | ||
|
|
||
| public function testCustomHeader() | ||
| { | ||
| $params = ['param1' => 'foo', 'param2' => 'bar']; | ||
| $json = json_encode(['custom_header_1' => 'custom_value_1']); | ||
|
|
||
| $email = new Email(); | ||
| $email->getHeaders() | ||
| ->add(new MetadataHeader('custom', $json)) | ||
| ->add(new TagHeader('TagInHeaders')) | ||
| ->addTextHeader('templateId', 1) | ||
| ->addParameterizedHeader('params', 'params', $params) | ||
| ->addTextHeader('foo', 'bar'); | ||
| $envelope = new Envelope(new Address('[email protected]', 'Alice'), [new Address('[email protected]', 'Bob')]); | ||
|
|
||
| $transport = new ResendApiTransport('ACCESS_KEY'); | ||
| $method = new \ReflectionMethod(ResendApiTransport::class, 'getPayload'); | ||
| $payload = $method->invoke($transport, $email, $envelope); | ||
|
|
||
| $this->assertArrayHasKey('X-Metadata-custom', $payload['headers']); | ||
| $this->assertEquals($json, $payload['headers']['X-Metadata-custom']); | ||
| $this->assertArrayHasKey('tags', $payload); | ||
| $this->assertEquals(['X-Tag' => 'TagInHeaders'], current($payload['tags'])); | ||
| $this->assertArrayHasKey('templateId', $payload['headers']); | ||
| $this->assertEquals('1', $payload['headers']['templateId']); | ||
| $this->assertArrayHasKey('params', $payload['headers']); | ||
| $this->assertEquals('params; param1=foo; param2=bar', $payload['headers']['params']); | ||
| $this->assertArrayHasKey('foo', $payload['headers']); | ||
| $this->assertEquals('bar', $payload['headers']['foo']); | ||
| } | ||
|
|
||
| public function testSendThrowsForErrorResponse() | ||
| { | ||
| $client = new MockHttpClient(function (string $method, string $url, array $options): ResponseInterface { | ||
| $this->assertSame('POST', $method); | ||
| $this->assertSame('https://api.resend.com:8984/emails', $url); | ||
| $this->assertStringContainsString('Accept: */*', $options['headers'][2] ?? $options['request_headers'][1]); | ||
|
|
||
| return new JsonMockResponse(['message' => 'i\'m a teapot'], [ | ||
| 'http_code' => 418, | ||
| ]); | ||
| }); | ||
|
|
||
| $transport = new ResendApiTransport('ACCESS_KEY', $client); | ||
| $transport->setPort(8984); | ||
|
|
||
| $mail = new Email(); | ||
| $mail->subject('Hello!') | ||
| ->to(new Address('[email protected]', 'Tony Stark')) | ||
| ->from(new Address('[email protected]', 'Fabien')) | ||
| ->text('Hello There!'); | ||
|
|
||
| $this->expectException(HttpTransportException::class); | ||
| $this->expectExceptionMessage('Unable to send an email: {"message":"i\'m a teapot"} (code 418).'); | ||
| $transport->send($mail); | ||
| } | ||
|
|
||
| public function testSend() | ||
| { | ||
| $client = new MockHttpClient(function (string $method, string $url, array $options): ResponseInterface { | ||
| $this->assertSame('POST', $method); | ||
| $this->assertSame('https://api.resend.com:8984/emails', $url); | ||
| $this->assertStringContainsString('Accept: */*', $options['headers'][2] ?? $options['request_headers'][1]); | ||
|
|
||
| return new JsonMockResponse(['id' => 'foobar'], [ | ||
| 'http_code' => 200, | ||
| ]); | ||
| }); | ||
|
|
||
| $transport = new ResendApiTransport('ACCESS_KEY', $client); | ||
| $transport->setPort(8984); | ||
|
|
||
| $mail = new Email(); | ||
| $mail->subject('Hello!') | ||
| ->to(new Address('[email protected]', 'Tony Stark')) | ||
| ->from(new Address('[email protected]', 'Fabien')) | ||
| ->text('Hello here!') | ||
| ->html('Hello there!') | ||
| ->addCc('[email protected]') | ||
| ->addBcc('[email protected]') | ||
| ->addReplyTo('[email protected]') | ||
| ->addPart(new DataPart('body')); | ||
|
|
||
| $message = $transport->send($mail); | ||
|
|
||
| $this->assertSame('foobar', $message->getMessageId()); | ||
| } | ||
|
|
||
| /** | ||
| * IDN (internationalized domain names) like kältetechnik-xyz.de need to be transformed to ACE | ||
| * (ASCII Compatible Encoding) e.g.xn--kltetechnik-xyz-0kb.de, otherwise resend api answers with 400 http code. | ||
| */ | ||
| public function testSendForIdnDomains() | ||
| { | ||
| $client = new MockHttpClient(function (string $method, string $url, array $options): ResponseInterface { | ||
| $this->assertSame('POST', $method); | ||
| $this->assertSame('https://api.resend.com:8984/emails', $url); | ||
| $this->assertStringContainsString('Accept: */*', $options['headers'][2] ?? $options['request_headers'][1]); | ||
|
|
||
| $body = json_decode($options['body'], true); | ||
| // to | ||
| $this->assertSame('kä[email protected]', $body['to'][0]); | ||
| // sender | ||
| $this->assertStringContainsString('[email protected]', $body['from']); | ||
| $this->assertStringContainsString('Kältetechnik Xyz', $body['from']); | ||
|
|
||
| return new JsonMockResponse(['id' => 'foobar'], [ | ||
| 'http_code' => 200, | ||
| ]); | ||
| }); | ||
|
|
||
| $transport = new ResendApiTransport('ACCESS_KEY', $client); | ||
| $transport->setPort(8984); | ||
|
|
||
| $mail = new Email(); | ||
| $mail->subject('Hello!') | ||
| ->to(new Address('kältetechnik@kältetechnik-xyz.de', 'Kältetechnik Xyz')) | ||
| ->from(new Address('info@kältetechnik-xyz.de', 'Kältetechnik Xyz')) | ||
| ->text('Hello here!') | ||
| ->html('Hello there!'); | ||
|
|
||
| $message = $transport->send($mail); | ||
|
|
||
| $this->assertSame('foobar', $message->getMessageId()); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.