Skip to content
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

Fixing the one-click unsubscribe header #3

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Fixing the one-click unsubscribe header #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
90dc8b1
Describing features
escopecz Jul 12, 2024
08131a3
wording improvement
escopecz Jul 17, 2024
67e9ba5
Adding return type
escopecz Jul 17, 2024
b1e211b
Merge branch 'main' of https://github.com/acquia/mc-cs-plugin-sparkpost
escopecz Jul 25, 2024
ce353c7
Let PHPUNIT tests fail
escopecz Jul 29, 2024
7776324
Adding test for segment emails with multiple contacts and BCC
escopecz Jul 29, 2024
eae8052
CS fix
escopecz Jul 29, 2024
f5f857d
STAN fix
escopecz Jul 29, 2024
2e1d01b
Adding the transactional header based on the List-Unsubscribe-Post he…
escopecz Jul 30, 2024
5f44124
Fixing the one-click unsubscribe header for multiple contact sends
escopecz Aug 26, 2024
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
9 changes: 6 additions & 3 deletions Mailer/Transport/SparkpostTransport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public function __toString(): string
* @throws DecodingExceptionInterface
* @throws RedirectionExceptionInterface
* @throws ServerExceptionInterface
* @throws TransportExceptionInterface
* @throws TransportException
*/
protected function doSendApi(SentMessage $sentMessage, Email $email, Envelope $envelope): ResponseInterface
{
Expand All @@ -92,8 +92,8 @@ protected function doSendApi(SentMessage $sentMessage, Email $email, Envelope $e
}

return $response;
} catch (\Exception $e) {
throw new TransportException($e->getMessage());
} catch (TransportExceptionInterface $e) {
throw new TransportException($e->getMessage(), 0, $e);
}
}

Expand Down Expand Up @@ -144,6 +144,7 @@ private function getSparkpostPayload(SentMessage $message): array
'options' => [
'open_tracking' => false,
'click_tracking' => false,
'transactional' => !$email->getHeaders()->get('List-Unsubscribe-Post'),
],
];
}
Expand Down Expand Up @@ -183,6 +184,8 @@ private function buildHeaders(MauticMessage $message): array
}
}

$result['List-Unsubscribe'] = '{{{ LISTUNSUBSCRIBEHEADER }}}';

return $result;
}

Expand Down
215 changes: 214 additions & 1 deletion Tests/Functional/Mailer/Transport/SparkpostTransportTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@

use Mautic\CoreBundle\Helper\UserHelper;
use Mautic\CoreBundle\Test\MauticMysqlTestCase;
use Mautic\EmailBundle\Entity\Email;
use Mautic\LeadBundle\Entity\Lead;
use Mautic\LeadBundle\Entity\LeadList;
use Mautic\LeadBundle\Entity\ListLead;
use PHPUnit\Framework\Assert;
use Symfony\Component\DomCrawler\Crawler;
use Symfony\Component\HttpClient\MockHttpClient;
Expand Down Expand Up @@ -90,6 +93,216 @@ function ($method, $url, $options): MockResponse {
Assert::assertSame('', $email->getReplyTo()[0]->getName());
}

public function testSegmentEmailSendToCoupleOfContactSync(): void
{
$segment = new LeadList();
$segment->setName('Test Segment');
$segment->setPublicName('Test Segment');
$segment->setAlias('test-segment');

$email = new Email();
$email->setName('Test Email');
$email->setSubject('Hello there!');
$email->setEmailType('list');
$email->setLists([$segment]);
$email->setCustomHtml('<html><body>Hello {contactfield=email}!</br>{unsubscribe_text}</body></html>');

$this->em->persist($segment);
$this->em->persist($email);
$this->em->flush();

$email->setPlainText('Dear {contactfield=email}');
$email->setFromAddress('[email protected]');
$email->setFromName('Custom From Name');
$email->setReplyToAddress('[email protected]');
$email->setBccAddress('[email protected]');
$email->setHeaders(['x-global-custom-header' => 'value123 overridden']);
$email->setUtmTags(
[
'utmSource' => 'utmSourceA',
'utmMedium' => 'utmMediumA',
'utmCampaign' => 'utmCampaignA',
'utmContent' => 'utmContentA',
]
);

foreach (['[email protected]', '[email protected]'] as $emailAddress) {
$contact = new Lead();
$contact->setEmail($emailAddress);

$member = new ListLead();
$member->setLead($contact);
$member->setList($segment);
$member->setDateAdded(new \DateTime());

$this->em->persist($member);
$this->em->persist($contact);
}

$this->em->persist($segment);
$this->em->persist($email);
$this->em->flush();

$assertRecipient = function (array $recipient, string $contactAddressWithoutDotPart, string $recipientAddressWithoutDotPart, Email $email): void {
// Address
$this->assertSame($recipientAddressWithoutDotPart.'.email', $recipient['address']['email']);

if ($contactAddressWithoutDotPart === $recipientAddressWithoutDotPart) {
// This is for the contact
$this->assertSame('', $recipient['address']['name']);

// Metadata
$this->assertSame(' ', $recipient['metadata']['name']);
$this->assertMatchesRegularExpression('/\d+/', $recipient['metadata']['leadId']);
$this->assertSame($email->getId(), $recipient['metadata']['emailId']);
$this->assertSame('Test Email', $recipient['metadata']['emailName']);
$this->assertMatchesRegularExpression('/[a-f0-9]{20,40}/', $recipient['metadata']['hashId']);
$this->assertTrue($recipient['metadata']['hashIdState']);
$this->assertSame(['email', $email->getId()], $recipient['metadata']['source']);
$this->assertSame('utmSourceA', $recipient['metadata']['utmTags']['utmSource']);
$this->assertSame('utmMediumA', $recipient['metadata']['utmTags']['utmMedium']);
$this->assertSame('utmCampaignA', $recipient['metadata']['utmTags']['utmCampaign']);
$this->assertSame('utmContentA', $recipient['metadata']['utmTags']['utmContent']);
} else {
// This is for the BCC
$this->assertSame($contactAddressWithoutDotPart.'.email', $recipient['header_to']);
}

// Substitution Data
$this->assertSame('Default Dynamic Content', $recipient['substitution_data']['DYNAMICCONTENTDYNAMICCONTENT1']);
$this->assertMatchesRegularExpression(
'/https:\/\/localhost\/email\/unsubscribe\/[a-f0-9]{20,40}\/'.$contactAddressWithoutDotPart.'\.email\/[a-f0-9]*/',
$recipient['substitution_data']['LISTUNSUBSCRIBEHEADER']
);

$this->assertMatchesRegularExpression(
'/<a href="https:\/\/localhost\/email\/unsubscribe\/[a-f0-9]{20,40}\/'.$contactAddressWithoutDotPart.'\.email\/[a-f0-9]*">Unsubscribe<\/a> to no longer receive emails from us./',
$recipient['substitution_data']['UNSUBSCRIBETEXT']
);
$this->assertMatchesRegularExpression(
'/https:\/\/localhost\/email\/unsubscribe\/[a-f0-9]{20,40}\/'.$contactAddressWithoutDotPart.'\.email\/[a-f0-9]*/',
$recipient['substitution_data']['UNSUBSCRIBEURL']
);
$this->assertMatchesRegularExpression(
'/<a href="https:\/\/localhost\/email\/view\/[a-f0-9]{20,40}">Having trouble reading this email\? Click here.<\/a>/',
$recipient['substitution_data']['WEBVIEWTEXT']
);
$this->assertMatchesRegularExpression(
'/https:\/\/localhost\/email\/view\/[a-f0-9]{20,40}/',
$recipient['substitution_data']['WEBVIEWURL']
);
$this->assertSame('', $recipient['substitution_data']['SIGNATURE']);
$this->assertSame('Hello there!', $recipient['substitution_data']['SUBJECT']);
$this->assertSame($contactAddressWithoutDotPart.'.email', $recipient['substitution_data']['CONTACTFIELDEMAIL']);
$this->assertSame('', $recipient['substitution_data']['OWNERFIELDEMAIL']);
$this->assertSame('', $recipient['substitution_data']['OWNERFIELDFIRSTNAME']);
$this->assertSame('', $recipient['substitution_data']['OWNERFIELDLASTNAME']);
$this->assertSame('', $recipient['substitution_data']['OWNERFIELDPOSITION']);
$this->assertSame('', $recipient['substitution_data']['OWNERFIELDSIGNATURE']);
$this->assertMatchesRegularExpression('/https:\/\/localhost\/email\/[a-f0-9]{20,40}\.gif/', $recipient['substitution_data']['TRACKINGPIXEL']);
};

$expectedResponses = [
function ($method, $url, $options): MockResponse {
Assert::assertSame(Request::METHOD_POST, $method);
Assert::assertSame('https://api.sparkpost.com/api/v1/utils/content-previewer/', $url);
$jsonArray = json_decode($options['body'], true);

// Content
$this->assertSame('Admin <[email protected]>', $jsonArray['content']['from']);
$this->assertSame('Hello there!', $jsonArray['content']['subject']);
$this->assertSame('value123', $jsonArray['content']['headers']['x-global-custom-header']);
$this->assertSame('Bulk', $jsonArray['content']['headers']['Precedence']);
$this->assertMatchesRegularExpression('/\d+/', $jsonArray['content']['headers']['X-EMAIL-ID'], 'X-EMAIL-ID does not match');
$this->assertSame('{{{ LISTUNSUBSCRIBEHEADER }}}', $jsonArray['content']['headers']['List-Unsubscribe']);
$this->assertSame('List-Unsubscribe=One-Click', $jsonArray['content']['headers']['List-Unsubscribe-Post']);
$this->assertSame('<html lang="en"><head><title>Hello there!</title></head><body>Hello {{{ CONTACTFIELDEMAIL }}}!</br>{{{ UNSUBSCRIBETEXT }}}<img height="1" width="1" src="{{{ TRACKINGPIXEL }}}" alt="" /></body></html>', $jsonArray['content']['html']);
$this->assertSame('Dear {{{ CONTACTFIELDEMAIL }}}', $jsonArray['content']['text']);
$this->assertSame('[email protected]', $jsonArray['content']['reply_to']);
$this->assertEmpty($jsonArray['content']['attachments']);

$this->assertNull($jsonArray['inline_css']);

// Tags
$this->assertEmpty($jsonArray['tags']);

// Campaign ID
$this->assertSame('utmCampaignA', $jsonArray['campaign_id']);

// Options
$this->assertFalse($jsonArray['options']['open_tracking']);
$this->assertFalse($jsonArray['options']['click_tracking']);
$this->assertFalse($jsonArray['options']['transactional']);
// Substitution Data
$this->assertSame('Default Dynamic Content', $jsonArray['substitution_data']['DYNAMICCONTENTDYNAMICCONTENT1']);
$this->assertMatchesRegularExpression('/<a href="https:\/\/localhost\/email\/unsubscribe\/[a-f0-9]{20,40}\/contact@(one|two)\.email\/[a-f0-9]*">Unsubscribe<\/a> to no longer receive emails from us./', $jsonArray['substitution_data']['UNSUBSCRIBETEXT'], 'UNSUBSCRIBETEXT does not match');
$this->assertMatchesRegularExpression('/https:\/\/localhost\/email\/unsubscribe\/[a-f0-9]{20,40}\/contact@(one|two)\.email\/[a-f0-9]*/', $jsonArray['substitution_data']['UNSUBSCRIBEURL'], 'UNSUBSCRIBEURL does not match');
$this->assertMatchesRegularExpression('/<a href="https:\/\/localhost\/email\/view\/[a-f0-9]{20,40}">Having trouble reading this email\? Click here\.<\/a>/', $jsonArray['substitution_data']['WEBVIEWTEXT'], 'WEBVIEWTEXT does not match');
$this->assertMatchesRegularExpression('/https:\/\/localhost\/email\/view\/[a-f0-9]*/', $jsonArray['substitution_data']['WEBVIEWURL'], 'WEBVIEWURL does not match');
$this->assertSame('', $jsonArray['substitution_data']['SIGNATURE']);
$this->assertSame('Hello there!', $jsonArray['substitution_data']['SUBJECT']);
$this->assertMatchesRegularExpression('/contact@(one|two)\.email/', $jsonArray['substitution_data']['CONTACTFIELDEMAIL'], 'CONTACTFIELDEMAIL does not match');
$this->assertSame('', $jsonArray['substitution_data']['OWNERFIELDEMAIL']);
$this->assertSame('', $jsonArray['substitution_data']['OWNERFIELDFIRSTNAME']);
$this->assertSame('', $jsonArray['substitution_data']['OWNERFIELDLASTNAME']);
$this->assertSame('', $jsonArray['substitution_data']['OWNERFIELDPOSITION']);
$this->assertSame('', $jsonArray['substitution_data']['OWNERFIELDSIGNATURE']);
$this->assertMatchesRegularExpression('/https:\/\/localhost\/email\/[a-f0-9]*\.gif/', $jsonArray['substitution_data']['TRACKINGPIXEL'], 'TRACKINGPIXEL does not match');

return new MockResponse('{"results": {"subject": "Hello there!", "html": "This is test body for {contactfield=email}!"}}');
},
function ($method, $url, $options) use ($assertRecipient, $email): MockResponse {
Assert::assertSame(Request::METHOD_POST, $method);
Assert::assertSame('https://api.sparkpost.com/api/v1/transmissions/', $url);
$jsonArray = json_decode($options['body'], true);
$this->assertSame('Admin <[email protected]>', $jsonArray['content']['from']);
$this->assertSame('Hello there!', $jsonArray['content']['subject']);
$this->assertSame('value123', $jsonArray['content']['headers']['x-global-custom-header']);
$this->assertSame('Bulk', $jsonArray['content']['headers']['Precedence']);
$this->assertMatchesRegularExpression('/\d+/', $jsonArray['content']['headers']['X-EMAIL-ID']);
$this->assertSame('{{{ LISTUNSUBSCRIBEHEADER }}}', $jsonArray['content']['headers']['List-Unsubscribe']);
$this->assertSame('List-Unsubscribe=One-Click', $jsonArray['content']['headers']['List-Unsubscribe-Post']);
$this->assertSame('<html lang="en"><head><title>Hello there!</title></head><body>Hello {{{ CONTACTFIELDEMAIL }}}!</br>{{{ UNSUBSCRIBETEXT }}}<img height="1" width="1" src="{{{ TRACKINGPIXEL }}}" alt="" /></body></html>', $jsonArray['content']['html']);
$this->assertSame('Dear {{{ CONTACTFIELDEMAIL }}}', $jsonArray['content']['text']);
$this->assertSame('[email protected]', $jsonArray['content']['reply_to']);
$this->assertEmpty($jsonArray['content']['attachments']);

// Recipients
$this->assertCount(4, $jsonArray['recipients']);

// Sort recipients by recipient email address and then by contact email address
usort($jsonArray['recipients'], function ($a, $b) {
$emailComparison = strcmp($a['substitution_data']['CONTACTFIELDEMAIL'], $b['substitution_data']['CONTACTFIELDEMAIL']);
if (0 === $emailComparison) {
return strcmp($a['address']['email'], $b['address']['email']);
}

return $emailComparison;
});

$assertRecipient($jsonArray['recipients'][0], 'contact@one', 'contact@one', $email);
$assertRecipient($jsonArray['recipients'][1], 'contact@one', 'custom@bcc', $email);
$assertRecipient($jsonArray['recipients'][2], 'contact@two', 'contact@two', $email);
$assertRecipient($jsonArray['recipients'][3], 'contact@two', 'custom@bcc', $email);

return new MockResponse('{"results": {"total_rejected_recipients": 0, "total_accepted_recipients": 1, "id": "11668787484950529"}}');
},
];

/** @var MockHttpClient $mockHttpClient */
$mockHttpClient = self::getContainer()->get(HttpClientInterface::class);
$mockHttpClient->setResponseFactory($expectedResponses);

$this->client->request(Request::METHOD_POST, '/s/ajax?action=email:sendBatch', [
'id' => $email->getId(),
'pending' => 2,
'batchLimit' => 10,
]);

$this->assertTrue($this->client->getResponse()->isOk(), $this->client->getResponse()->getContent());
$this->assertSame('{"success":1,"percent":100,"progress":[2,2],"stats":{"sent":2,"failed":0,"failedRecipients":[]}}', $this->client->getResponse()->getContent());
}

public function testTestTransportButton(): void
{
$expectedResponses = [
Expand Down Expand Up @@ -136,7 +349,7 @@ private function assertSparkpostRequestBody(string $body): void
Assert::assertSame('[email protected]', $bodyArray['content']['reply_to']);
Assert::assertSame('Hello there!', $bodyArray['content']['subject']);
Assert::assertSame('This is test body for {{{ CONTACTFIELDEMAIL }}}!', $bodyArray['content']['text']);
Assert::assertSame(['open_tracking' => false, 'click_tracking' => false], $bodyArray['options']);
Assert::assertSame(['open_tracking' => false, 'click_tracking' => false, 'transactional' => true], $bodyArray['options']);
Assert::assertSame('[email protected]', $bodyArray['substitution_data']['CONTACTFIELDEMAIL']);
Assert::assertSame('Hello there!', $bodyArray['substitution_data']['SUBJECT']);
Assert::assertArrayHasKey('SIGNATURE', $bodyArray['substitution_data']);
Expand Down
Loading