Added MailerSend mailer bridge

symfony · doobas · Feb 21, 2023 · Feb 21, 2023 · Feb 21, 2023 · Feb 22, 2023
commit 40bb194b48072f42432bfcd4702f5df60a4b106c
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -98,6 +98,7 @@
 use Symfony\Component\Mailer\Bridge\Google\Transport\GmailTransportFactory;
 use Symfony\Component\Mailer\Bridge\Infobip\Transport\InfobipTransportFactory as InfobipMailerTransportFactory;
 use Symfony\Component\Mailer\Bridge\Mailchimp\Transport\MandrillTransportFactory;
+use Symfony\Component\Mailer\Bridge\MailerSend\Transport\MailerSendTransportFactory;
 use Symfony\Component\Mailer\Bridge\Mailgun\Transport\MailgunTransportFactory;
 use Symfony\Component\Mailer\Bridge\Mailjet\Transport\MailjetTransportFactory;
 use Symfony\Component\Mailer\Bridge\MailPace\Transport\MailPaceTransportFactory;
@@ -2454,6 +2455,7 @@ private function registerMailerConfiguration(array $config, ContainerBuilder $co
         $classToServices = [
             GmailTransportFactory::class => 'mailer.transport_factory.gmail',
             InfobipMailerTransportFactory::class => 'mailer.transport_factory.infobip',
+            MailerSendTransportFactory::class => 'mailer.transport_factory.mailersend',
             MailgunTransportFactory::class => 'mailer.transport_factory.mailgun',
             MailjetTransportFactory::class => 'mailer.transport_factory.mailjet',
             MailPaceTransportFactory::class => 'mailer.transport_factory.mailpace',

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/mailer_transports.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/mailer_transports.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Mailer\Bridge\Google\Transport\GmailTransportFactory;
 use Symfony\Component\Mailer\Bridge\Infobip\Transport\InfobipTransportFactory;
 use Symfony\Component\Mailer\Bridge\Mailchimp\Transport\MandrillTransportFactory;
+use Symfony\Component\Mailer\Bridge\MailerSend\Transport\MailerSendTransportFactory;
 use Symfony\Component\Mailer\Bridge\Mailgun\Transport\MailgunTransportFactory;
 use Symfony\Component\Mailer\Bridge\Mailjet\Transport\MailjetTransportFactory;
 use Symfony\Component\Mailer\Bridge\MailPace\Transport\MailPaceTransportFactory;
@@ -51,6 +52,10 @@
             ->parent('mailer.transport_factory.abstract')
             ->tag('mailer.transport_factory')
 
+        ->set('mailer.transport_factory.mailersend', MailerSendTransportFactory::class)
+            ->parent('mailer.transport_factory.abstract')
+            ->tag('mailer.transport_factory')
+
         ->set('mailer.transport_factory.mailchimp', MandrillTransportFactory::class)
             ->parent('mailer.transport_factory.abstract')
             ->tag('mailer.transport_factory')

diff --git a/src/Symfony/Component/Mailer/Bridge/MailerSend/.gitattributes b/src/Symfony/Component/Mailer/Bridge/MailerSend/.gitattributes
@@ -0,0 +1,4 @@
+/Tests export-ignore
+/phpunit.xml.dist export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
diff --git a/src/Symfony/Component/Mailer/Bridge/MailerSend/.gitignore b/src/Symfony/Component/Mailer/Bridge/MailerSend/.gitignore
@@ -0,0 +1,2 @@
+vendor/
+composer.lock
diff --git a/src/Symfony/Component/Mailer/Bridge/MailerSend/CHANGELOG.md b/src/Symfony/Component/Mailer/Bridge/MailerSend/CHANGELOG.md
@@ -0,0 +1,7 @@
+CHANGELOG
+=========
+
+6.3
+---
+
+* Add the bridge
diff --git a/src/Symfony/Component/Mailer/Bridge/MailerSend/LICENSE b/src/Symfony/Component/Mailer/Bridge/MailerSend/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2019-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.
diff --git a/src/Symfony/Component/Mailer/Bridge/MailerSend/README.md b/src/Symfony/Component/Mailer/Bridge/MailerSend/README.md
@@ -0,0 +1,21 @@
+MailerSend Bridge
+===============
+
+Provides MailerSend integration for Symfony Mailer.
+
+## Configuration example:
+
+```env
+# API
+MAILER_DSN=mailersend+api://$MAILERSEND_API_KEY@default
+# SMTP
+MAILER_DSN=mailersend+smtp://$MAILERSEND_SMTP_USERNAME:$MAILERSEND_SMTP_PASSWORD@default
+```
+
+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)
diff --git a/...Symfony/Component/Mailer/Bridge/MailerSend/Tests/Transport/MailerSendApiTransportTest.php b/...Symfony/Component/Mailer/Bridge/MailerSend/Tests/Transport/MailerSendApiTransportTest.php
@@ -0,0 +1,198 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Mailer\Bridge\MailerSend\Tests\Transport;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpClient\MockHttpClient;
+use Symfony\Component\HttpClient\Response\MockResponse;
+use Symfony\Component\Mailer\Bridge\MailerSend\Transport\MailerSendApiTransport;
+use Symfony\Component\Mailer\Exception\HttpTransportException;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\Email;
+use Symfony\Component\Mime\Part\DataPart;
+use Symfony\Contracts\HttpClient\ResponseInterface;
+
+class MailerSendApiTransportTest extends TestCase
+{
+    /**
+     * @dataProvider getTransportData
+     */
+    public function testToString(MailerSendApiTransport $transport, string $expected)
+    {
+        $this->assertSame($expected, (string) $transport);
+    }
+
+    public static function getTransportData()
+    {
+        yield [
+            new MailerSendApiTransport('ACCESS_KEY'),
+            'mailersend+api://api.mailersend.com',
+        ];
+
+        yield [
+            (new MailerSendApiTransport('ACCESS_KEY'))->setHost('example.com'),
+            'mailersend+api://example.com',
+        ];
+
+        yield [
+            (new MailerSendApiTransport('ACCESS_KEY'))->setHost('example.com')->setPort(99),
+            'mailersend+api://example.com:99',
+        ];
+    }
+
+    public function testSendBasicEmail()
+    {
+        $client = new MockHttpClient(function (string $method, string $url, array $options): ResponseInterface {
+            $this->assertSame('POST', $method);
+            $this->assertSame('https://api.mailersend.com/v1/email', $url);
+
+            $body = json_decode($options['body'], true);
+            $this->assertSame('test_from@example.com', $body['from']['email']);
+            $this->assertSame('Test from name', $body['from']['name']);
+            $this->assertSame('test_to@example.com', $body['to'][0]['email']);
+            $this->assertSame('Test to name', $body['to'][0]['name']);
+            $this->assertSame('Test subject', $body['subject']);
+            $this->assertSame('Lorem ipsum.', $body['text']);
+            $this->assertSame('<html><body><p>Lorem ipsum.</p></body></html>', $body['html']);
+
+            return new MockResponse('', [
+                'http_code' => 202,
+                'response_headers' => ['x-message-id' => 'test_message_id'],
+            ]);
+        });
+
+        $transport = new MailerSendApiTransport('ACCESS_KEY', $client);
+
+        $mail = new Email();
+        $mail->subject('Test subject')
+            ->to(new Address('test_to@example.com', 'Test to name'))
+            ->from(new Address('test_from@example.com', 'Test from name'))
+            ->addCc('test_cc@example.com')
+            ->addBcc('test_bcc@example.com')
+            ->addReplyTo('test_reply_to@example.com')
+            ->text('Lorem ipsum.')
+            ->html('<html><body><p>Lorem ipsum.</p></body></html>');
+
+        $message = $transport->send($mail);
+
+        $this->assertSame('test_message_id', $message->getMessageId());
+    }
+
+    public function testSendEmailWithAttachment()
+    {
+        $client = new MockHttpClient(function (string $method, string $url, array $options): ResponseInterface {
+            $this->assertSame('POST', $method);
+            $this->assertSame('https://api.mailersend.com/v1/email', $url);
+
+            $body = json_decode($options['body'], true);
+
+            $this->assertSame('content', base64_decode($body['attachments'][0]['content']));
+            $this->assertSame('attachment.txt', $body['attachments'][0]['filename']);
+            $this->assertSame('inline content', base64_decode($body['attachments'][1]['content']));
+            $this->assertSame('inline.txt', $body['attachments'][1]['filename']);
+            $this->assertSame('inline', $body['attachments'][1]['disposition']);
+            $this->assertSame('test_cid@symfony', $body['attachments'][1]['id']);
+
+            return new MockResponse('', [
+                'http_code' => 202,
+                'response_headers' => ['x-message-id' => 'test_message_id'],
+            ]);
+        });
+
+        $transport = new MailerSendApiTransport('ACCESS_KEY', $client);
+
+        $mail = new Email();
+        $mail->subject('Test subject')
+            ->to(new Address('test_to@example.com', 'Test to name'))
+            ->from(new Address('test_from@example.com', 'Test from name'))
+            ->addCc('test_cc@example.com')
+            ->addBcc('test_bcc@example.com')
+            ->addReplyTo('test_reply_to@example.com')
+            ->html('<html><body><p>Lorem ipsum.</p><img src="cid:test_cid@symfony"></body></html>')
+            ->addPart(new DataPart('content', 'attachment.txt', 'text/plain'))
+            ->addPart((new DataPart('inline content', 'inline.txt', 'text/plain'))->asInline()->setContentId('test_cid@symfony'));
+
+        $message = $transport->send($mail);
+
+        $this->assertSame('test_message_id', $message->getMessageId());
+    }
+
+    public function testSendThrowsForErrorResponse()
+    {
+        $client = new MockHttpClient(function (string $method, string $url, array $options): ResponseInterface {
+            return new MockResponse(json_encode(['message' => 'i\'m a teapot']), [
+                'http_code' => 418,
+            ]);
+        });
+
+        $transport = new MailerSendApiTransport('ACCESS_KEY', $client);
+
+        $mail = new Email();
+        $mail->subject('Test subject')
+            ->to(new Address('test_to@example.com', 'Test to name'))
+            ->from(new Address('test_from@example.com', 'Test from name'))
+            ->text('Lorem ipsum.');
+
+        $this->expectException(HttpTransportException::class);
+        $this->expectExceptionMessage('Unable to send an email: i\'m a teapot (code 418).');
+        $transport->send($mail);
+    }
+
+    public function testSendThrowsForAllSuppressed()
+    {
+        $client = new MockHttpClient(function (string $method, string $url, array $options): ResponseInterface {
+            return new MockResponse(json_encode([
+                'message' => 'There are some warnings for your request.',
+                'warnings' => [
+                    [
+                        'type' => 'ALL_SUPPRESSED',
+                    ],
+                ],
+            ], \JSON_THROW_ON_ERROR), [
+                'http_code' => 202,
+            ]);
+        });
+
+        $transport = new MailerSendApiTransport('ACCESS_KEY', $client);
+
+        $mail = new Email();
+        $mail->subject('Test subject')
+            ->to(new Address('test_to@example.com', 'Test to name'))
+            ->from(new Address('test_from@example.com', 'Test from name'))
+            ->text('Lorem ipsum.');
+
+        $this->expectException(HttpTransportException::class);
+        $this->expectExceptionMessage('Unable to send an email: There are some warnings for your request.');
+        $transport->send($mail);
+    }
+
+    public function testSendThrowsForBadResponse()
+    {
+        $client = new MockHttpClient(function (string $method, string $url, array $options): ResponseInterface {
+            return new MockResponse('test', [
+                'http_code' => 202,
+            ]);
+        });
+
+        $transport = new MailerSendApiTransport('ACCESS_KEY', $client);
+
+        $mail = new Email();
+        $mail->subject('Test subject')
+            ->to(new Address('test_to@example.com', 'Test to name'))
+            ->from(new Address('test_from@example.com', 'Test from name'))
+            ->text('Lorem ipsum.');
+
+        $this->expectException(HttpTransportException::class);
+        $this->expectExceptionMessage('Unable to send an email: "test" (code 202).');
+        $transport->send($mail);
+    }
+}
diff --git a/...ony/Component/Mailer/Bridge/MailerSend/Tests/Transport/MailerSendTransportFactoryTest.php b/...ony/Component/Mailer/Bridge/MailerSend/Tests/Transport/MailerSendTransportFactoryTest.php
@@ -0,0 +1,90 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Mailer\Bridge\MailerSend\Tests\Transport;
+
+use Symfony\Component\Mailer\Bridge\MailerSend\Transport\MailerSendApiTransport;
+use Symfony\Component\Mailer\Bridge\MailerSend\Transport\MailerSendSmtpTransport;
+use Symfony\Component\Mailer\Bridge\MailerSend\Transport\MailerSendTransportFactory;
+use Symfony\Component\Mailer\Test\TransportFactoryTestCase;
+use Symfony\Component\Mailer\Transport\Dsn;
+use Symfony\Component\Mailer\Transport\TransportFactoryInterface;
+
+class MailerSendTransportFactoryTest extends TransportFactoryTestCase
+{
+    public static function getFactory(): TransportFactoryInterface
+    {
+        return new MailerSendTransportFactory(self::getDispatcher(), self::getClient(), self::getLogger());
+    }
+
+    public static function supportsProvider(): iterable
+    {
+        yield [
+            new Dsn('mailersend', 'default'),
+            true,
+        ];
+
+        yield [
+            new Dsn('mailersend+smtp', 'default'),
+            true,
+        ];
+
+        yield [
+            new Dsn('mailersend+smtp', 'example.com'),
+            true,
+        ];
+
+        yield [
+            new Dsn('mailersend+api', 'default'),
+            true,
+        ];
+    }
+
+    public static function createProvider(): iterable
+    {
+        yield [
+            new Dsn('mailersend', 'default', self::USER, self::PASSWORD),
+            new MailerSendSmtpTransport(self::USER, self::PASSWORD, self::getDispatcher(), self::getLogger()),
+        ];
+
+        yield [
+            new Dsn('mailersend+smtp', 'default', self::USER, self::PASSWORD),
+            new MailerSendSmtpTransport(self::USER, self::PASSWORD, self::getDispatcher(), self::getLogger()),
+        ];
+
+        yield [
+            new Dsn('mailersend+smtp', 'default', self::USER, self::PASSWORD, 465),
+            new MailerSendSmtpTransport(self::USER, self::PASSWORD, self::getDispatcher(), self::getLogger()),
+        ];
+
+        yield [
+            new Dsn('mailersend+api', 'default', self::USER),
+            new MailerSendApiTransport(self::USER, self::getClient(), self::getDispatcher(), self::getLogger()),
+        ];
+    }
+
+    public static function unsupportedSchemeProvider(): iterable
+    {
+        yield [
+            new Dsn('mailersend+foo', 'default', self::USER, self::PASSWORD),
+            'The "mailersend+foo" scheme is not supported; supported schemes for mailer "mailersend" are: "mailersend", "mailersend+smtp", "mailersend+api".',
+        ];
+    }
+
+    public static function incompleteDsnProvider(): iterable
+    {
+        yield [new Dsn('mailersend+smtp', 'default', self::USER)];
+
+        yield [new Dsn('mailersend+smtp', 'default', null, self::PASSWORD)];
+
+        yield [new Dsn('mailersend+api', 'default')];
+    }
+}