[Mailer] Make sure you can pass custom headers to Mailgun

Nyholm · nicolas-grekas · commit c877c841317d · 2020-01-04T14:10:16.000+01:00
diff --git a/Mailchimp/Tests/Transport/MandrillApiTransportTest.php b/Mailchimp/Tests/Transport/MandrillApiTransportTest.php
@@ -13,6 +13,9 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Mailer\Bridge\Mailchimp\Transport\MandrillApiTransport;
+use Symfony\Component\Mailer\Envelope;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\Email;
 
 class MandrillApiTransportTest extends TestCase
 {
@@ -41,4 +44,21 @@ public function getTransportData()
             ],
         ];
     }
+
+    public function testCustomHeader()
+    {
+        $email = new Email();
+        $email->getHeaders()->addTextHeader('foo', 'bar');
+        $envelope = new Envelope(new Address('alice@system.com'), [new Address('bob@system.com')]);
+
+        $transport = new MandrillApiTransport('ACCESS_KEY');
+        $method = new \ReflectionMethod(MandrillApiTransport::class, 'getPayload');
+        $method->setAccessible(true);
+        $payload = $method->invoke($transport, $email, $envelope);
+
+        $this->assertArrayHasKey('message', $payload);
+        $this->assertArrayHasKey('headers', $payload['message']);
+        $this->assertCount(1, $payload['message']['headers']);
+        $this->assertEquals('foo: bar', $payload['message']['headers'][0]);
+    }
 }
diff --git a/Mailchimp/Transport/MandrillApiTransport.php b/Mailchimp/Transport/MandrillApiTransport.php
@@ -111,7 +111,7 @@ private function getPayload(Email $email, Envelope $envelope): array
                 continue;
             }
 
-            $payload['message']['headers'][] = $name.': '.$header->toString();
+            $payload['message']['headers'][] = $name.': '.$header->getBodyAsString();
         }
 
         return $payload;
diff --git a/Mailgun/Tests/Transport/MailgunApiTransportTest.php b/Mailgun/Tests/Transport/MailgunApiTransportTest.php
@@ -13,6 +13,9 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Mailer\Bridge\Mailgun\Transport\MailgunApiTransport;
+use Symfony\Component\Mailer\Envelope;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\Email;
 
 class MailgunApiTransportTest extends TestCase
 {
@@ -45,4 +48,20 @@ public function getTransportData()
             ],
         ];
     }
+
+    public function testCustomHeader()
+    {
+        $json = json_encode(['foo' => 'bar']);
+        $email = new Email();
+        $email->getHeaders()->addTextHeader('X-Mailgun-Variables', $json);
+        $envelope = new Envelope(new Address('alice@system.com'), [new Address('bob@system.com')]);
+
+        $transport = new MailgunApiTransport('ACCESS_KEY', 'DOMAIN');
+        $method = new \ReflectionMethod(MailgunApiTransport::class, 'getPayload');
+        $method->setAccessible(true);
+        $payload = $method->invoke($transport, $email, $envelope);
+
+        $this->assertArrayHasKey('h:x-mailgun-variables', $payload);
+        $this->assertEquals($json, $payload['h:x-mailgun-variables']);
+    }
 }
diff --git a/Mailgun/Transport/MailgunApiTransport.php b/Mailgun/Transport/MailgunApiTransport.php
@@ -114,7 +114,7 @@ private function getPayload(Email $email, Envelope $envelope): array
                 continue;
             }
 
-            $payload['h:'.$name] = $header->toString();
+            $payload['h:'.$name] = $header->getBodyAsString();
         }
 
         return $payload;
diff --git a/MailgunApiTransport.php b/MailgunApiTransport.php
@@ -114,7 +114,7 @@ private function getPayload(Email $email, Envelope $envelope): array
                 continue;
             }
 
-            $payload['h:'.$name] = $header->toString();
+            $payload['h:'.$name] = $header->getBodyAsString();
         }
 
         return $payload;
diff --git a/MailgunApiTransportTest.php b/MailgunApiTransportTest.php
@@ -13,6 +13,9 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Mailer\Bridge\Mailgun\Transport\MailgunApiTransport;
+use Symfony\Component\Mailer\Envelope;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\Email;
 
 class MailgunApiTransportTest extends TestCase
 {
@@ -45,4 +48,20 @@ public function getTransportData()
             ],
         ];
     }
+
+    public function testCustomHeader()
+    {
+        $json = json_encode(['foo' => 'bar']);
+        $email = new Email();
+        $email->getHeaders()->addTextHeader('X-Mailgun-Variables', $json);
+        $envelope = new Envelope(new Address('alice@system.com'), [new Address('bob@system.com')]);
+
+        $transport = new MailgunApiTransport('ACCESS_KEY', 'DOMAIN');
+        $method = new \ReflectionMethod(MailgunApiTransport::class, 'getPayload');
+        $method->setAccessible(true);
+        $payload = $method->invoke($transport, $email, $envelope);
+
+        $this->assertArrayHasKey('h:x-mailgun-variables', $payload);
+        $this->assertEquals($json, $payload['h:x-mailgun-variables']);
+    }
 }
diff --git a/MandrillApiTransport.php b/MandrillApiTransport.php
@@ -111,7 +111,7 @@ private function getPayload(Email $email, Envelope $envelope): array
                 continue;
             }
 
-            $payload['message']['headers'][] = $name.': '.$header->toString();
+            $payload['message']['headers'][] = $name.': '.$header->getBodyAsString();
         }
 
         return $payload;
diff --git a/MandrillApiTransportTest.php b/MandrillApiTransportTest.php
@@ -13,6 +13,9 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Mailer\Bridge\Mailchimp\Transport\MandrillApiTransport;
+use Symfony\Component\Mailer\Envelope;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\Email;
 
 class MandrillApiTransportTest extends TestCase
 {
@@ -41,4 +44,21 @@ public function getTransportData()
             ],
         ];
     }
+
+    public function testCustomHeader()
+    {
+        $email = new Email();
+        $email->getHeaders()->addTextHeader('foo', 'bar');
+        $envelope = new Envelope(new Address('alice@system.com'), [new Address('bob@system.com')]);
+
+        $transport = new MandrillApiTransport('ACCESS_KEY');
+        $method = new \ReflectionMethod(MandrillApiTransport::class, 'getPayload');
+        $method->setAccessible(true);
+        $payload = $method->invoke($transport, $email, $envelope);
+
+        $this->assertArrayHasKey('message', $payload);
+        $this->assertArrayHasKey('headers', $payload['message']);
+        $this->assertCount(1, $payload['message']['headers']);
+        $this->assertEquals('foo: bar', $payload['message']['headers'][0]);
+    }
 }
diff --git a/Postmark/Tests/Transport/PostmarkApiTransportTest.php b/Postmark/Tests/Transport/PostmarkApiTransportTest.php
@@ -13,6 +13,9 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Mailer\Bridge\Postmark\Transport\PostmarkApiTransport;
+use Symfony\Component\Mailer\Envelope;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\Email;
 
 class PostmarkApiTransportTest extends TestCase
 {
@@ -41,4 +44,21 @@ public function getTransportData()
             ],
         ];
     }
+
+    public function testCustomHeader()
+    {
+        $email = new Email();
+        $email->getHeaders()->addTextHeader('foo', 'bar');
+        $envelope = new Envelope(new Address('alice@system.com'), [new Address('bob@system.com')]);
+
+        $transport = new PostmarkApiTransport('ACCESS_KEY');
+        $method = new \ReflectionMethod(PostmarkApiTransport::class, 'getPayload');
+        $method->setAccessible(true);
+        $payload = $method->invoke($transport, $email, $envelope);
+
+        $this->assertArrayHasKey('Headers', $payload);
+        $this->assertCount(1, $payload['Headers']);
+
+        $this->assertEquals(['Name' => 'foo', 'Value' => 'bar'], $payload['Headers'][0]);
+    }
 }
diff --git a/Postmark/Transport/PostmarkApiTransport.php b/Postmark/Transport/PostmarkApiTransport.php
@@ -84,7 +84,7 @@ private function getPayload(Email $email, Envelope $envelope): array
 
             $payload['Headers'][] = [
                 'Name' => $name,
-                'Value' => $header->toString(),
+                'Value' => $header->getBodyAsString(),
             ];
         }
 
diff --git a/PostmarkApiTransport.php b/PostmarkApiTransport.php
@@ -84,7 +84,7 @@ private function getPayload(Email $email, Envelope $envelope): array
 
             $payload['Headers'][] = [
                 'Name' => $name,
-                'Value' => $header->toString(),
+                'Value' => $header->getBodyAsString(),
             ];
         }
 
diff --git a/PostmarkApiTransportTest.php b/PostmarkApiTransportTest.php
@@ -13,6 +13,9 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Mailer\Bridge\Postmark\Transport\PostmarkApiTransport;
+use Symfony\Component\Mailer\Envelope;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\Email;
 
 class PostmarkApiTransportTest extends TestCase
 {
@@ -41,4 +44,21 @@ public function getTransportData()
             ],
         ];
     }
+
+    public function testCustomHeader()
+    {
+        $email = new Email();
+        $email->getHeaders()->addTextHeader('foo', 'bar');
+        $envelope = new Envelope(new Address('alice@system.com'), [new Address('bob@system.com')]);
+
+        $transport = new PostmarkApiTransport('ACCESS_KEY');
+        $method = new \ReflectionMethod(PostmarkApiTransport::class, 'getPayload');
+        $method->setAccessible(true);
+        $payload = $method->invoke($transport, $email, $envelope);
+
+        $this->assertArrayHasKey('Headers', $payload);
+        $this->assertCount(1, $payload['Headers']);
+
+        $this->assertEquals(['Name' => 'foo', 'Value' => 'bar'], $payload['Headers'][0]);
+    }
 }
diff --git a/Sendgrid/Tests/Transport/SendgridApiTransportTest.php b/Sendgrid/Tests/Transport/SendgridApiTransportTest.php
@@ -13,6 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Mailer\Bridge\Sendgrid\Transport\SendgridApiTransport;
+use Symfony\Component\Mailer\Envelope;
 use Symfony\Component\Mime\Address;
 use Symfony\Component\Mime\Email;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
@@ -149,4 +150,20 @@ public function testLineBreaksInEncodedAttachment()
 
         $mailer->send($email);
     }
+
+    public function testCustomHeader()
+    {
+        $email = new Email();
+        $email->getHeaders()->addTextHeader('foo', 'bar');
+        $envelope = new Envelope(new Address('alice@system.com'), [new Address('bob@system.com')]);
+
+        $transport = new SendgridApiTransport('ACCESS_KEY');
+        $method = new \ReflectionMethod(SendgridApiTransport::class, 'getPayload');
+        $method->setAccessible(true);
+        $payload = $method->invoke($transport, $email, $envelope);
+
+        $this->assertArrayHasKey('headers', $payload);
+        $this->assertArrayHasKey('foo', $payload['headers']);
+        $this->assertEquals('bar', $payload['headers']['foo']);
+    }
 }
diff --git a/Sendgrid/Transport/SendgridApiTransport.php b/Sendgrid/Transport/SendgridApiTransport.php
@@ -104,7 +104,7 @@ private function getPayload(Email $email, Envelope $envelope): array
                 continue;
             }
 
-            $payload['headers'][$name] = $header->toString();
+            $payload['headers'][$name] = $header->getBodyAsString();
         }
 
         return $payload;
diff --git a/SendgridApiTransport.php b/SendgridApiTransport.php
@@ -104,7 +104,7 @@ private function getPayload(Email $email, Envelope $envelope): array
                 continue;
             }
 
-            $payload['headers'][$name] = $header->toString();
+            $payload['headers'][$name] = $header->getBodyAsString();
         }
 
         return $payload;
diff --git a/SendgridApiTransportTest.php b/SendgridApiTransportTest.php
@@ -13,6 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Mailer\Bridge\Sendgrid\Transport\SendgridApiTransport;
+use Symfony\Component\Mailer\Envelope;
 use Symfony\Component\Mime\Address;
 use Symfony\Component\Mime\Email;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
@@ -149,4 +150,20 @@ public function testLineBreaksInEncodedAttachment()
 
         $mailer->send($email);
     }
+
+    public function testCustomHeader()
+    {
+        $email = new Email();
+        $email->getHeaders()->addTextHeader('foo', 'bar');
+        $envelope = new Envelope(new Address('alice@system.com'), [new Address('bob@system.com')]);
+
+        $transport = new SendgridApiTransport('ACCESS_KEY');
+        $method = new \ReflectionMethod(SendgridApiTransport::class, 'getPayload');
+        $method->setAccessible(true);
+        $payload = $method->invoke($transport, $email, $envelope);
+
+        $this->assertArrayHasKey('headers', $payload);
+        $this->assertArrayHasKey('foo', $payload['headers']);
+        $this->assertEquals('bar', $payload['headers']['foo']);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ private function getPayload(Email $email, Envelope $envelope): array`
`111`	`111`	`continue;`
`112`	`112`	`}`
`113`	`113`
`114`		`- $payload['message']['headers'][] = $name.': '.$header->toString();`
	`114`	`+ $payload['message']['headers'][] = $name.': '.$header->getBodyAsString();`
`115`	`115`	`}`
`116`	`116`
`117`	`117`	`return $payload;`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ private function getPayload(Email $email, Envelope $envelope): array`
`114`	`114`	`continue;`
`115`	`115`	`}`
`116`	`116`
`117`		`- $payload['h:'.$name] = $header->toString();`
	`117`	`+ $payload['h:'.$name] = $header->getBodyAsString();`
`118`	`118`	`}`
`119`	`119`
`120`	`120`	`return $payload;`
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`	`$payload['Headers'][] = [`
`86`	`86`	`'Name' => $name,`
`87`		`- 'Value' => $header->toString(),`
	`87`	`+ 'Value' => $header->getBodyAsString(),`
`88`	`88`	`];`
`89`	`89`	`}`
`90`	`90`