use the same transport for both Mailtrap's live and sandbox API

Author: xabbuh

src/Symfony/Component/Mailer/Bridge/Mailtrap/Tests/Transport/MailtrapApiSandboxTransportTest.php

@@ -48,6 +48,22 @@ public static function getTransportData(): array
                 (new MailtrapApiTransport('KEY'))->setHost('example.com')->setPort(99),
                 'mailtrap+api://example.com:99',
             ],
+            [
+                new MailtrapApiTransport('KEY', null, null, null, 123456),
+                'mailtrap+sandbox://sandbox.api.mailtrap.io/?inboxId=123456',
+            ],
+            [
+                (new MailtrapApiTransport('KEY', null, null, null, 123456))->setHost('example.com'),
+                'mailtrap+sandbox://example.com/?inboxId=123456',
+            ],
+            [
+                (new MailtrapApiTransport('KEY', null, null, null, 123456))->setHost('example.com')->setPort(99),
+                'mailtrap+sandbox://example.com:99/?inboxId=123456',
+            ],
+            [
+                new MailtrapApiTransport('KEY', null, null, null, 123456),
+                'mailtrap+sandbox://sandbox.api.mailtrap.io/?inboxId=123456',
+            ],
         ];
     }
 
@@ -65,7 +81,7 @@ public function testCustomHeader()
         $this->assertSame(['foo' => 'bar'], $payload['headers']);
     }
 
-    public function testSend()
+    public function testSendToLiveApi()
     {
         $client = new MockHttpClient(function (string $method, string $url, array $options): ResponseInterface {
             $this->assertSame('POST', $method);
@@ -93,6 +109,34 @@ public function testSend()
         $transport->send($mail);
     }
 
+    public function testSendToSandboxApi()
+    {
+        $client = new MockHttpClient(function (string $method, string $url, array $options): ResponseInterface {
+            $this->assertSame('POST', $method);
+            $this->assertSame('https://sandbox.api.mailtrap.io/api/send/123456', $url);
+
+            $body = json_decode($options['body'], true);
+            $this->assertSame(['email' => 'fabpot@symfony.com', 'name' => 'Fabien'], $body['from']);
+            $this->assertSame([['email' => 'kevin@symfony.com', 'name' => 'Kevin']], $body['to']);
+            $this->assertSame('Hello!', $body['subject']);
+            $this->assertSame('Hello There!', $body['text']);
+
+            return new JsonMockResponse([], [
+                'http_code' => 200,
+            ]);
+        });
+
+        $transport = new MailtrapApiTransport('KEY', $client, null, null, 123456);
+
+        $mail = new Email();
+        $mail->subject('Hello!')
+            ->to(new Address('kevin@symfony.com', 'Kevin'))
+            ->from(new Address('fabpot@symfony.com', 'Fabien'))
+            ->text('Hello There!');
+
+        $transport->send($mail);
+    }
+
     public function testSendThrowsForErrorResponse()
     {
         $client = new MockHttpClient(static fn (string $method, string $url, array $options): ResponseInterface => new JsonMockResponse(['errors' => ['i\'m a teapot']], [

src/Symfony/Component/Mailer/Bridge/Mailtrap/Tests/Transport/MailtrapApiTransportTest.php

@@ -13,7 +13,6 @@
 
 use Psr\Log\NullLogger;
 use Symfony\Component\HttpClient\MockHttpClient;
-use Symfony\Component\Mailer\Bridge\Mailtrap\Transport\MailtrapApiSandboxTransport;
 use Symfony\Component\Mailer\Bridge\Mailtrap\Transport\MailtrapApiTransport;
 use Symfony\Component\Mailer\Bridge\Mailtrap\Transport\MailtrapSmtpTransport;
 use Symfony\Component\Mailer\Bridge\Mailtrap\Transport\MailtrapTransportFactory;
@@ -80,12 +79,12 @@ public static function createProvider(): iterable
 
         yield [
             new Dsn('mailtrap+sandbox', 'default', self::USER, null, null, ['inboxId' => '123456']),
-            new MailtrapApiSandboxTransport(self::USER, 123456, new MockHttpClient(), null, $logger),
+            new MailtrapApiTransport(self::USER, new MockHttpClient(), null, $logger, 123456),
         ];
 
         yield [
             new Dsn('mailtrap+sandbox', 'example.com', self::USER, null, 8080, ['inboxId' => '123456']),
-            (new MailtrapApiSandboxTransport(self::USER, 123456, new MockHttpClient(), null, $logger))->setHost('example.com')->setPort(8080),
+            (new MailtrapApiTransport(self::USER, new MockHttpClient(), null, $logger, 123456))->setHost('example.com')->setPort(8080),
         ];
 
         yield [

src/Symfony/Component/Mailer/Bridge/Mailtrap/Tests/Transport/MailtrapTransportFactoryTest.php

@@ -30,28 +30,34 @@
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
  */
-class MailtrapApiTransport extends AbstractApiTransport
+final class MailtrapApiTransport extends AbstractApiTransport
 {
-    protected const HOST = 'send.api.mailtrap.io';
+    private const LIVE_API_HOST = 'send.api.mailtrap.io';
+    private const SANDBOX_API_HOST = 'sandbox.api.mailtrap.io';
     private const HEADERS_TO_BYPASS = ['from', 'to', 'cc', 'bcc', 'subject', 'content-type', 'sender'];
 
     public function __construct(
         #[\SensitiveParameter] private string $token,
         ?HttpClientInterface $client = null,
         ?EventDispatcherInterface $dispatcher = null,
         ?LoggerInterface $logger = null,
+        private ?int $inboxId = null,
     ) {
         parent::__construct($client, $dispatcher, $logger);
     }
 
     public function __toString(): string
     {
-        return \sprintf('mailtrap+api://%s%s', $this->host ?: static::HOST, $this->port ? ':'.$this->port : '');
+        if (null !== $this->inboxId) {
+            return \sprintf('mailtrap+sandbox://%s/?inboxId=%d', $this->getEndpoint(), $this->inboxId);
+        }
+
+        return \sprintf('mailtrap+api://%s', $this->getEndpoint());
     }
 
     protected function doSendApi(SentMessage $sentMessage, Email $email, Envelope $envelope): ResponseInterface
     {
-        $response = $this->client->request('POST', 'https://'.$this->getEndpoint(), [
+        $response = $this->client->request('POST', 'https://'.$this->getEndpoint().'/api/send'.(null !== $this->inboxId ? '/'.$this->inboxId : ''), [
             'json' => $this->getPayload($email, $envelope),
             'auth_bearer' => $this->token,
         ]);
@@ -143,8 +149,16 @@ private static function encodeEmail(Address $address): array
         return array_filter(['email' => $address->getEncodedAddress(), 'name' => $address->getName()]);
     }
 
-    protected function getEndpoint(): string
+    private function getEndpoint(): string
     {
-        return ($this->host ?: static::HOST).($this->port ? ':'.$this->port : '').'/api/send';
+        if ($this->host) {
+            $host = $this->host;
+        } elseif (null !== $this->inboxId) {
+            $host = self::SANDBOX_API_HOST;
+        } else {
+            $host = self::LIVE_API_HOST;
+        }
+
+        return $host.($this->port ? ':'.$this->port : '');
     }
 }

src/Symfony/Component/Mailer/Bridge/Mailtrap/Transport/MailtrapApiSandboxTransport.php

@@ -29,12 +29,9 @@ public function create(Dsn $dsn): TransportInterface
         if ('mailtrap+api' === $scheme || 'mailtrap+sandbox' === $scheme) {
             $host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
             $port = $dsn->getPort();
+            $inboxId = 'mailtrap+sandbox' === $scheme ? $dsn->getOption('inboxId') : null;
 
-            if ('mailtrap+api' === $scheme) {
-                return (new MailtrapApiTransport($user, $this->client, $this->dispatcher, $this->logger))->setHost($host)->setPort($port);
-            } else {
-                return (new MailtrapApiSandboxTransport($user, $dsn->getOption('inboxId'), $this->client, $this->dispatcher, $this->logger))->setHost($host)->setPort($port);
-            }
+            return (new MailtrapApiTransport($user, $this->client, $this->dispatcher, $this->logger, $inboxId))->setHost($host)->setPort($port);
         }
 
         if ('mailtrap+smtp' === $scheme || 'mailtrap+smtps' === $scheme || 'mailtrap' === $scheme) {