[Mailer] [Mailgun] Fix sender header encoding

spajxo · nicolas-grekas · commit 0f3b2f79fdfa · 2024-01-29T14:04:40.000+01:00
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailgun/Tests/Transport/MailgunApiTransportTest.php b/src/Symfony/Component/Mailer/Bridge/Mailgun/Tests/Transport/MailgunApiTransportTest.php
@@ -270,4 +270,17 @@ public function testTagAndMetadataHeaders()
         $this->assertArrayHasKey('v:Client-ID', $payload);
         $this->assertSame('12345', $payload['v:Client-ID']);
     }
+
+    public function testEnvelopeSenderHeaderIsCorrectlyEncoded()
+    {
+        $email = new Email();
+        $envelope = new Envelope(new Address('alice@system.com', 'Žluťoučký Kůň'), [new Address('bob@system.com')]);
+
+        $transport = new MailgunApiTransport('ACCESS_KEY', 'DOMAIN');
+        $method = new \ReflectionMethod(MailgunApiTransport::class, 'getPayload');
+        $payload = $method->invoke($transport, $email, $envelope);
+
+        $this->assertArrayHasKey('h:Sender', $payload);
+        $this->assertSame('=?utf-8?Q?=C5=BDlu=C5=A5ou=C4=8Dk=C3=BD_K=C5=AF=C5=88?= <alice@system.com>', $payload['h:Sender']);
+    }
 }
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunApiTransport.php
@@ -87,7 +87,7 @@ protected function doSendApi(SentMessage $sentMessage, Email $email, Envelope $e
     private function getPayload(Email $email, Envelope $envelope): array
     {
         $headers = $email->getHeaders();
-        $headers->addHeader('h:Sender', $envelope->getSender()->toString());
+        $headers->addMailboxHeader('h:Sender', $envelope->getSender());
         $html = $email->getHtmlBody();
         if (null !== $html && \is_resource($html)) {
             if (stream_get_meta_data($html)['seekable'] ?? false) {

Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ protected function doSendApi(SentMessage $sentMessage, Email $email, Envelope $e`
`87`	`87`	`private function getPayload(Email $email, Envelope $envelope): array`
`88`	`88`	`{`
`89`	`89`	`$headers = $email->getHeaders();`
`90`		`- $headers->addHeader('h:Sender', $envelope->getSender()->toString());`
	`90`	`+ $headers->addMailboxHeader('h:Sender', $envelope->getSender());`
`91`	`91`	`$html = $email->getHtmlBody();`
`92`	`92`	`if (null !== $html && \is_resource($html)) {`
`93`	`93`	`if (stream_get_meta_data($html)['seekable'] ?? false) {`