8000 Added deprecation · symfony/symfony@e9ad571 · GitHub
[go: up one dir, main page]
Skip to content

Commit e9ad571

Browse files
NyholmNyholm
committed
Added deprecation
1 parent cadd6ef commit e9ad571

File tree

4 files changed

+41
-3
lines changed

4 files changed

+41
-3
lines changed

‎UPGRADE-5.1.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@ HttpFoundation
3939
`__construct()` instead)
4040
* Made the Mime component an optional dependency
4141

42+
Mailer
43+
------
44+
45+
* Deprecated passing Mailgun headers without their "h:" prefix.
46+
4247
Messenger
4348
---------
4449

‎src/Symfony/Component/Mailer/Bridge/Mailgun/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
CHANGELOG
22
=========
33

4+
5.1.0
5+
6+
* Not prefixing headers with "h:" is deprecated.
7+
48
4.4.0
59
-----
610

‎src/Symfony/Component/Mailer/Bridge/Mailgun/Tests/Transport/MailgunApiTransportTest.php

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,12 @@ public function testCustomHeader()
6363
$email = new Email();
6464
$email->getHeaders()->addTextHeader('X-Mailgun-Variables', $json);
6565
$email->getHeaders()->addTextHeader('h:foo', 'foo-value');
66-
$email->getHeaders()->addTextHeader('bar', 'bar-value');
6766
$email->getHeaders()->addTextHeader('t:text', 'text-value');
6867
$email->getHeaders()->addTextHeader('o:deliverytime', $deliveryTime);
6968
$email->getHeaders()->addTextHeader('v:version', 'version-value');
69+
$email->getHeaders()->addTextHeader('template', 'template-value');
70+
$email->getHeaders()->addTextHeader('recipient-variables', 'recipient-variables-value');
71+
$email->getHeaders()->addTextHeader('amp-html', 'amp-html-value');
7072
$envelope = new Envelope(new Address('alice@system.com'), [new Address('bob@system.com')]);
7173

7274
$transport = new MailgunApiTransport('ACCESS_KEY', 'DOMAIN');
@@ -79,14 +81,40 @@ public function testCustomHeader()
7981

8082
$this->assertArrayHasKey('h:foo', $payload);
8183
$this->assertEquals('foo-value', $payload['h:foo']);
82-
$this->assertArrayHasKey('h:bar', $payload, 'We should prefix headers with "h:" to keep BC');
83-
$this->assertEquals('bar-value', $payload['h:bar']);
8484
$this->assertArrayHasKey('t:text', $payload);
8585
$this->assertEquals('text-value', $payload['t:text']);
8686
$this->assertArrayHasKey('o:deliverytime', $payload);
8787 $this->assertEquals($deliveryTime, $payload['o:deliverytime']);
8888
$this->assertArrayHasKey('v:version', $payload);
8989
$this->assertEquals('version-value', $payload['v:version']);
90+
$this->assertArrayHasKey('template', $payload);
91+
$this->assertEquals('template-value', $payload['template']);
92+
$this->assertArrayHasKey('recipient-variables', $payload);
93+
$this->assertEquals('recipient-variables-value', $payload['recipient-variables']);
94+
$this->assertArrayHasKey('amp-html', $payload);
95+
$this->assertEquals('amp-html-value', $payload['amp-html']);
96+
}
97+
98+
/**
99+
* @legacy
100+
*/
101+
public function testPrefixHeaderWithH()
102+
{
103+
$json = json_encode(['foo' => 'bar']);
104+
$deliveryTime = (new \DateTimeImmutable('2020-03-20 13:01:00'))->format(\DateTimeImmutable::RFC2822);
105+
106+
$email = new Email();
107+
$email->getHeaders()->addTextHeader('bar', 'bar-value');
108+
109+
$envelope = new Envelope(new Address('alice@system.com'), [new Address('bob@system.com')]);
110+
111+
$transport = new MailgunApiTransport('ACCESS_KEY', 'DOMAIN');
112+
$method = new \ReflectionMethod(MailgunApiTransport::class, 'getPayload');
113+
$method->setAccessible(true);
114+
$payload = $method->invoke($transport, $email, $envelope);
115+
116+
$this->assertArrayHasKey('h:bar', $payload, 'We should prefix headers with "h:" to keep BC');
117+
$this->assertEquals('bar-value', $payload['h:bar']);
90118
}
91119

92120
public function testSend()

‎src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunApiTransport.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ private function getPayload(Email $email, Envelope $envelope): array
135135
} else {
136136
// fallback to prefix with "h:" to not break BC
137137
$headerName = 'h:'.$name;
138+
@trigger_error(sprintf('Not prefixing the Mailgun header name with "h:" is deprecated since Symfony 5.1. Use header name "%s" instead.', $headerName), E_USER_DEPRECATED);
138139
}
139140

140141
$payload[$headerName] = $header->getBodyAsString();

0 commit comments

Comments
 (0)
0