bug #51773 [Mailer] [Mailgun] Fix outlook sender (Romanavr)

This PR was squashed before being merged into the 6.3 branch.

Discussion
----------

[Mailer] [Mailgun] Fix outlook sender

| Q             | A
| ------------- | ---
| Branch?       | 6.3
| Bug fix?      | yes
| New feature?  | no <!-- please update src/**/CHANGELOG.md files -->
| Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Tickets       | Fix symfony/symfony#51596
| License       | MIT

This PR solves the problem related to displaying the sender in the OutLook email client when sending an email from a subdomain.
Check more details by following these links:
https://serverfault.com/questions/1097879/sender-and-from-header-domain-mismatch-causes-malformed-display-in-outlook
https://stackoverflow.com/questions/28401673/removing-on-behalf-of-when-sending-mail-using-mailgun/45445015#45445015

Commits
-------

09d49f9875 [Mailer] [Mailgun] Fix outlook sender

Tests/Transport/MailgunApiTransportTest.php

@@ -61,6 +61,8 @@ public function testCustomHeader()
         $deliveryTime = (new \DateTimeImmutable('2020-03-20 13:01:00'))->format(\DateTimeInterface::RFC2822);
 
         $email = new Email();
+        $envelope = new Envelope(new Address('[email protected]'), [new Address('[email protected]')]);
+        $email->getHeaders()->addTextHeader('h:sender', $envelope->getSender()->toString());
         $email->getHeaders()->addTextHeader('h:X-Mailgun-Variables', $json);
         $email->getHeaders()->addTextHeader('h:foo', 'foo-value');
         $email->getHeaders()->addTextHeader('t:text', 'text-value');
@@ -69,7 +71,6 @@ public function testCustomHeader()
         $email->getHeaders()->addTextHeader('template', 'template-value');
         $email->getHeaders()->addTextHeader('recipient-variables', 'recipient-variables-value');
         $email->getHeaders()->addTextHeader('amp-html', 'amp-html-value');
-        $envelope = new Envelope(new Address('[email protected]'), [new Address('[email protected]')]);
 
         $transport = new MailgunApiTransport('ACCESS_KEY', 'DOMAIN');
         $method = new \ReflectionMethod(MailgunApiTransport::class, 'getPayload');
@@ -78,6 +79,8 @@ public function testCustomHeader()
         $this->assertArrayHasKey('h:X-Mailgun-Variables', $payload);
         $this->assertEquals($json, $payload['h:X-Mailgun-Variables']);
 
+        $this->assertArrayHasKey('h:sender', $payload);
+        $this->assertEquals($envelope->getSender()->toString(), $payload['h:sender']);
         $this->assertArrayHasKey('h:foo', $payload);
         $this->assertEquals('foo-value', $payload['h:foo']);
         $this->assertArrayHasKey('t:text', $payload);

Tests/Transport/MailgunHttpTransportTest.php

@@ -69,6 +69,8 @@ public function testSend()
             $this->assertStringContainsString('Subject: Hello!', $content);
             $this->assertStringContainsString('To: Saif Eddin <[email protected]>', $content);
             $this->assertStringContainsString('From: Fabien <[email protected]>', $content);
+            $this->assertStringContainsString('Sender: Senior Fabien Eddin <[email protected]>', $content);
+            $this->assertStringContainsString('h:sender: "Senior Fabien Eddin" <[email protected]>', $content);
             $this->assertStringContainsString('Hello There!', $content);
 
             return new MockResponse(json_encode(['id' => 'foobar']), [
@@ -79,11 +81,17 @@ public function testSend()
         $transport->setPort(8984);
 
         $mail = new Email();
+        $toAddress = new Address('[email protected]', 'Saif Eddin');
+        $fromAddress = new Address('[email protected]', 'Fabien');
+        $senderAddress = new Address('[email protected]', 'Senior Fabien Eddin');
         $mail->subject('Hello!')
-            ->to(new Address('[email protected]', 'Saif Eddin'))
-            ->from(new Address('[email protected]', 'Fabien'))
+            ->to($toAddress)
+            ->from($fromAddress)
+            ->sender($senderAddress)
             ->text('Hello There!');
 
+        $mail->getHeaders()->addHeader('h:sender', $mail->getSender()->toString());
+
         $message = $transport->send($mail);
 
         $this->assertSame('foobar', $message->getMessageId());

Transport/MailgunApiTransport.php

@@ -87,6 +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());
         $html = $email->getHtmlBody();
         if (null !== $html && \is_resource($html)) {
             if (stream_get_meta_data($html)['seekable'] ?? false) {

Transport/MailgunHttpTransport.php

@@ -53,6 +53,7 @@ public function __toString(): string
     protected function doSendHttp(SentMessage $message): ResponseInterface
     {
         $body = new FormDataPart([
+            'h:sender' => $message->getEnvelope()->getSender()->toString(),
             'to' => implode(',', $this->stringifyAddresses($message->getEnvelope()->getRecipients())),
             'message' => new DataPart($message->toString(), 'message.mime'),
         ]);