Skip to content

[Mailer] Mailjet Add ability to pass custom headers to API #37934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 27, 2020
Merged

[Mailer] Mailjet Add ability to pass custom headers to API #37934

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Mailjet/Tests/Transport/MailjetApiTransportTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
<?php

namespace Symfony\Component\Mailer\Bridge\Mailjet\Tests\Transport;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Mailer\Bridge\Mailjet\Transport\MailjetApiTransport;
use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Email;

class MailjetApiTransportTest extends TestCase
{
protected const USER = 'u$er';
protected const PASSWORD = 'pa$s';

/**
* @dataProvider getTransportData
*/
public function testToString(MailjetApiTransport $transport, string $expected)
{
$this->assertSame($expected, (string) $transport);
}

public function getTransportData()
{
return [
[
new MailjetApiTransport(self::USER, self::PASSWORD),
'mailjet+api://api.mailjet.com',
],
[
(new MailjetApiTransport(self::USER, self::PASSWORD))->setHost('example.com'),
'mailjet+api://example.com',
],
];
}

public function testPayloadFormat()
{
$email = (new Email())
->subject('Sending email to mailjet API');
$email->getHeaders()
->addTextHeader('X-authorized-header', 'authorized')
->addTextHeader('X-MJ-TemplateLanguage', 'forbidden'); // This header is forbidden
$envelope = new Envelope(new Address('foo@example.com', 'Foo'), [new Address('bar@example.com', 'Bar'), new Address('baz@example.com', 'Baz')]);

$transport = new MailjetApiTransport(self::USER, self::PASSWORD);
$method = new \ReflectionMethod(MailjetApiTransport::class, 'getPayload');
$method->setAccessible(true);
$payload = $method->invoke($transport, $email, $envelope);

$this->assertArrayHasKey('Messages', $payload);
$this->assertNotEmpty($payload['Messages']);

$message = $payload['Messages'][0];
$this->assertArrayHasKey('Subject', $message);
$this->assertEquals('Sending email to mailjet API', $message['Subject']);

$this->assertArrayHasKey('Headers', $message);
$headers = $message['Headers'];
$this->assertArrayHasKey('X-authorized-header', $headers);
$this->assertEquals('authorized', $headers['X-authorized-header']);
$this->assertArrayNotHasKey('x-mj-templatelanguage', $headers);
$this->assertArrayNotHasKey('X-MJ-TemplateLanguage', $headers);

$this->assertArrayHasKey('From', $message);
$sender = $message['From'];
$this->assertArrayHasKey('Email', $sender);
$this->assertArrayHasKey('Name', $sender);
$this->assertEquals('foo@example.com', $sender['Email']);
$this->assertEquals('Foo', $sender['Name']);

$this->assertArrayHasKey('To', $message);
$recipients = $message['To'];
$this->assertIsArray($recipients);
$this->assertCount(2, $recipients);
$this->assertEquals('bar@example.com', $recipients[0]['Email']);
$this->assertEquals('', $recipients[0]['Name']); // For Recipients, even if the name is filled, it is empty
$this->assertEquals('baz@example.com', $recipients[1]['Email']);
$this->assertEquals('', $recipients[1]['Name']);
}
}
16 changes: 16 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Mailjet/Tests/Transport/MailjetTransportFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

namespace Symfony\Component\Mailer\Bridge\Mailjet\Tests\Transport;

use Symfony\Component\Mailer\Bridge\Mailjet\Transport\MailjetApiTransport;
use Symfony\Component\Mailer\Bridge\Mailjet\Transport\MailjetSmtpTransport;
use Symfony\Component\Mailer\Bridge\Mailjet\Transport\MailjetTransportFactory;
use Symfony\Component\Mailer\Test\TransportFactoryTestCase;
Expand All @@ -26,6 +27,11 @@ public function getFactory(): TransportFactoryInterface

public function supportsProvider(): iterable
{
yield [
new Dsn('mailjet+api', 'default'),
true,
];

yield [
new Dsn('mailjet', 'default'),
true,
Expand All @@ -52,6 +58,16 @@ public function createProvider(): iterable
$dispatcher = $this->getDispatcher();
$logger = $this->getLogger();

yield [
new Dsn('mailjet+api', 'default', self::USER, self::PASSWORD),
new MailjetApiTransport(self::USER, self::PASSWORD, $this->getClient(), $dispatcher, $logger),
];

yield [
new Dsn('mailjet+api', 'example.com', self::USER, self::PASSWORD),
(new MailjetApiTransport(self::USER, self::PASSWORD, $this->getClient(), $dispatcher, $logger))->setHost('example.com'),
];

yield [
new Dsn('mailjet', 'default', self::USER, self::PASSWORD),
new MailjetSmtpTransport(self::USER, self::PASSWORD, $dispatcher, $logger),
Expand Down
17 changes: 17 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Mailjet/Transport/MailjetApiTransport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,15 @@ class MailjetApiTransport extends AbstractApiTransport
{
private const HOST = 'api.mailjet.com';
private const API_VERSION = '3.1';
private const FORBIDDEN_HEADERS = [
'Date', 'X-CSA-Complaints', 'Message-Id', 'X-Mailjet-Campaign', 'X-MJ-StatisticsContactsListID',
'DomainKey-Status', 'Received-SPF', 'Authentication-Results', 'Received', 'X-Mailjet-Prio',
'From', 'Sender', 'Subject', 'To', 'Cc', 'Bcc', 'Return-Path', 'Delivered-To', 'DKIM-Signature',
'X-Feedback-Id', 'X-Mailjet-Segmentation', 'List-Id', 'X-MJ-MID', 'X-MJ-ErrorMessage',
'X-MJ-TemplateErrorDeliver', 'X-MJ-TemplateErrorReporting', 'X-MJ-TemplateLanguage',
'X-Mailjet-Debug', 'User-Agent', 'X-Mailer', 'X-MJ-CustomID', 'X-MJ-EventPayload', 'X-MJ-Vars',
'X-Mailjet-TrackOpen', 'X-Mailjet-TrackClick', 'X-MJ-TemplateID', 'X-MJ-WorkflowID',
];

private $privateKey;
private $publicKey;
Expand Down Expand Up @@ -104,6 +113,14 @@ private function getPayload(Email $email, Envelope $envelope): array
$message['HTMLPart'] = $html;
}

foreach ($email->getHeaders()->all() as $header) {
if (\in_array($header->getName(), self::FORBIDDEN_HEADERS, true)) {
continue;
}

$message['Headers'][$header->getName()] = $header->getBodyAsString();
}

return [
'Messages' => [$message],
];
Expand Down
3 changes: 2 additions & 1 deletion src/Symfony/Component/Mailer/Bridge/Mailjet/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
],
"require": {
"php": "^7.2.5",
"symfony/mailer": "^4.4|^5.0"
"symfony/mailer": "^4.4|^5.0",
"symfony/mime": "^5.2"
},
"require-dev": {
"symfony/http-client": "^4.4|^5.0"
Expand Down