[Sendgrid-Mailer] Fixed envelope recipients on sendgridApiTransport

arendjantetteroo · arendjantetteroo · commit c4e5131757c7 · 2020-08-18T12:11:56.000+02:00
Fixes #37870 The SendgridApiTransport was not using the envelope to get the recipients, so overriding the recipients with the EnvelopeListener was not working.
diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/Transport/SendgridApiTransportTest.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/Transport/SendgridApiTransportTest.php
@@ -192,4 +192,34 @@ public function testReplyTo()
         $this->assertArrayHasKey('email', $payload['reply_to']);
         $this->assertSame($replyTo, $payload['reply_to']['email']);
     }
+
+    public function testEnvelopeSenderAndRecipients()
+    {
+        $from = 'from@example.com';
+        $to = 'to@example.com';
+        $envelopeFrom = 'envelopefrom@example.com';
+        $envelopeTo = 'envelopeto@example.com';
+        $email = new Email();
+        $email->from($from)
+            ->to($to)
+            ->cc('cc@example.com')
+            ->bcc('bcc@example.com')
+            ->text('content');
+        $envelope = new Envelope(new Address($envelopeFrom), [new Address($envelopeTo)]);
+
+        $transport = new SendgridApiTransport('ACCESS_KEY');
+        $method = new \ReflectionMethod(SendgridApiTransport::class, 'getPayload');
+        $method->setAccessible(true);
+        $payload = $method->invoke($transport, $email, $envelope);
+
+        $this->assertArrayHasKey('from', $payload);
+        $this->assertArrayHasKey('email', $payload['from']);
+        $this->assertSame($envelopeFrom, $payload['from']['email']);
+
+        $this->assertArrayHasKey('personalizations', $payload);
+        $this->assertArrayHasKey('to', $payload['personalizations'][0]);
+        $this->assertArrayHasKey('email', $payload['personalizations'][0]['to'][0]);
+        $this->assertCount(1, $payload['personalizations'][0]['to']);
+        $this->assertSame($envelopeTo, $payload['personalizations'][0]['to'][0]['email']);
+    }
 }
diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/Transport/SendgridApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/Transport/SendgridApiTransport.php
@@ -84,7 +84,7 @@ private function getPayload(Email $email, Envelope $envelope): array
         }
 
         $personalization = [
-            'to' => array_map($addressStringifier, $email->getTo()),
+            'to' => array_map($addressStringifier, $this->getRecipients($email, $envelope)),
             'subject' => $email->getSubject(),
         ];
         if ($emails = array_map($addressStringifier, $email->getCc())) {

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ private function getPayload(Email $email, Envelope $envelope): array`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`$personalization = [`
`87`		`- 'to' => array_map($addressStringifier, $email->getTo()),`
	`87`	`+ 'to' => array_map($addressStringifier, $this->getRecipients($email, $envelope)),`
`88`	`88`	`'subject' => $email->getSubject(),`
`89`	`89`	`];`
`90`	`90`	`if ($emails = array_map($addressStringifier, $email->getCc())) {`