[Mailer] Fix addresses management in Sendgrid API payload

Author: Guillaume Verstraete

Sendgrid/Tests/Transport/SendgridApiTransportTest.php

@@ -13,6 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Mailer\Bridge\Sendgrid\Transport\SendgridApiTransport;
+use Symfony\Component\Mime\Address;
 use Symfony\Component\Mime\Email;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
@@ -48,8 +49,8 @@ public function getTransportData()
     public function testSend()
     {
         $email = new Email();
-        $email->from('foo@example.com')
-            ->to('bar@example.com')
+        $email->from(new Address('foo@example.com', 'Ms. Foo Bar'))
+            ->to(new Address('bar@example.com', 'Mr. Recipient'))
             ->bcc('baz@example.com')
             ->text('content');
 
@@ -73,12 +74,18 @@ public function testSend()
                 'json' => [
                     'personalizations' => [
                         [
-                            'to' => [['email' => 'bar@example.com']],
+                            'to' => [[
+                                'email' => 'bar@example.com',
+                                'name' => 'Mr. Recipient',
+                            ]],
                             'subject' => null,
                             'bcc' => [['email' => 'baz@example.com']],
                         ],
                     ],
-                    'from' => ['email' => 'foo@example.com'],
+                    'from' => [
+                        'email' => 'foo@example.com',
+                        'name' => 'Ms. Foo Bar',
+                    ],
                     'content' => [
                         ['type' => 'text/plain', 'value' => 'content'],
                     ],

Sendgrid/Transport/SendgridApiTransport.php

@@ -63,11 +63,19 @@ protected function doSendApi(SentMessage $sentMessage, Email $email, Envelope $e
 
     private function getPayload(Email $email, Envelope $envelope): array
     {
-        $addressStringifier = function (Address $address) {return ['email' => $address->toString()]; };
+        $addressStringifier = function (Address $address) {
+            $stringified = ['email' => $address->getAddress()];
+
+            if ($address->getName()) {
+                $stringified['name'] = $address->getName();
+            }
+
+            return $stringified;
+        };
 
         $payload = [
             'personalizations' => [],
-            'from' => ['email' => $envelope->getSender()->toString()],
+            'from' => $addressStringifier($envelope->getSender()),
             'content' => $this->getContent($email),
         ];
 

SendgridApiTransport.php

@@ -63,11 +63,19 @@ protected function doSendApi(SentMessage $sentMessage, Email $email, Envelope $e
 
     private function getPayload(Email $email, Envelope $envelope): array
     {
-        $addressStringifier = function (Address $address) {return ['email' => $address->toString()]; };
+        $addressStringifier = function (Address $address) {
+            $stringified = ['email' => $address->getAddress()];
+
+            if ($address->getName()) {
+                $stringified['name'] = $address->getName();
+            }
+
+            return $stringified;
+        };
 
         $payload = [
             'personalizations' => [],
-            'from' => ['email' => $envelope->getSender()->toString()],
+            'from' => $addressStringifier($envelope->getSender()),
             'content' => $this->getContent($email),
         ];
 

SendgridApiTransportTest.php

@@ -13,6 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Mailer\Bridge\Sendgrid\Transport\SendgridApiTransport;
+use Symfony\Component\Mime\Address;
 use Symfony\Component\Mime\Email;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
@@ -48,8 +49,8 @@ public function getTransportData()
     public function testSend()
     {
         $email = new Email();
-        $email->from('foo@example.com')
-            ->to('bar@example.com')
+        $email->from(new Address('foo@example.com', 'Ms. Foo Bar'))
+            ->to(new Address('bar@example.com', 'Mr. Recipient'))
             ->bcc('baz@example.com')
             ->text('content');
 
@@ -73,12 +74,18 @@ public function testSend()
                 'json' => [
                     'personalizations' => [
                         [
-                            'to' => [['email' => 'bar@example.com']],
+                            'to' => [[
+                                'email' => 'bar@example.com',
+                                'name' => 'Mr. Recipient',
+                            ]],
                             'subject' => null,
                             'bcc' => [['email' => 'baz@example.com']],
                         ],
                     ],
-                    'from' => ['email' => 'foo@example.com'],
+                    'from' => [
+                        'email' => 'foo@example.com',
+                        'name' => 'Ms. Foo Bar',
+                    ],
                     'content' => [
                         ['type' => 'text/plain', 'value' => 'content'],
                     ],