symfony · fabpot · Aug 4, 2023 · Aug 4, 2023
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/CHANGELOG.md b/src/Symfony/Component/Mailer/Bridge/Brevo/CHANGELOG.md
@@ -4,4 +4,5 @@ CHANGELOG
 6.4
 ---
 
+* Add support for `RemoteEvent` and `Webhook`
 * Add the bridge as a replacement of the deprecated Sendinblue one
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/RemoteEvent/BrevoPayloadConverter.php b/src/Symfony/Component/Mailer/Bridge/Brevo/RemoteEvent/BrevoPayloadConverter.php
@@ -0,0 +1,67 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Mailer\Bridge\Brevo\RemoteEvent;
+
+use Symfony\Component\RemoteEvent\Event\Mailer\AbstractMailerEvent;
+use Symfony\Component\RemoteEvent\Event\Mailer\MailerDeliveryEvent;
+use Symfony\Component\RemoteEvent\Event\Mailer\MailerEngagementEvent;
+use Symfony\Component\RemoteEvent\Exception\ParseException;
+use Symfony\Component\RemoteEvent\PayloadConverterInterface;
+
+final class BrevoPayloadConverter implements PayloadConverterInterface
+{
+    public function convert(array $payload): AbstractMailerEvent
+    {
+        if (\in_array($payload['event'], ['request', 'deferred', 'delivered', 'soft_bounce', 'hard_bounce', 'invalid_email', 'blocked', 'error'], true)) {
+            $name = match ($payload['event']) {
+                'request' => MailerDeliveryEvent::RECEIVED,
+                'deferred' => MailerDeliveryEvent::DEFERRED,
+                'delivered' => MailerDeliveryEvent::DELIVERED,
+                'soft_bounce' => MailerDeliveryEvent::BOUNCE,
+                'hard_bounce' => MailerDeliveryEvent::BOUNCE,
+                'invalid_email' => MailerDeliveryEvent::DROPPED,
+                'blocked' => MailerDeliveryEvent::DROPPED,
+                'error' => MailerDeliveryEvent::DROPPED,
+            };
+
+            $event = new MailerDeliveryEvent($name, $payload['message-id'], $payload);
+        } else {
+            $name = match ($payload['event']) {
+                'click' => MailerEngagementEvent::CLICK,
+                'unsubscribed' => MailerEngagementEvent::UNSUBSCRIBE,
+   
8000
             'unique_opened' => MailerEngagementEvent::OPEN,
+                'opened' => MailerEngagementEvent::OPEN,
+                'proxy_open' => MailerEngagementEvent::OPEN,
+                'complaint' => MailerEngagementEvent::SPAM,
+                default => throw new ParseException(sprintf('Unsupported event "%s".', $payload['event'])),
+            };
+            $event = new MailerEngagementEvent($name, $payload['message-id'], $payload);
+        }
+
+        if (!$date = \DateTimeImmutable::createFromFormat('U', $payload['ts_event'])) {
+            throw new ParseException(sprintf('Invalid date "%s".', $payload['ts_event']));
+        }
+
+        if (
+            \in_array($payload['event'], ['deferred', 'soft_bounce', 'hard_bounce', 'invalid_email', 'blocked', 'error'], true)
+            && isset($payload['reason'])
+        ) {
+            $event->setReason($payload['reason']);
+        }
+
+        $event->setDate($date);
+        $event->setRecipientEmail($payload['email']);
+        $event->setTags($payload['tags']);
+
+        return $event;
+    }
+}
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/BrevoRequestParserTest.php b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/BrevoRequestParserTest.php
@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Mailer\Bridge\Brevo\Tests\Webhook;
+
+use Symfony\Component\Mailer\Bridge\Brevo\RemoteEvent\BrevoPayloadConverter;
+use Symfony\Component\Mailer\Bridge\Brevo\Webhook\BrevoRequestParser;
+use Symfony\Component\Webhook\Client\RequestParserInterface;
+use Symfony\Component\Webhook\Test\AbstractRequestParserTestCase;
+
+class BrevoRequestParserTest extends AbstractRequestParserTestCase
+{
+    protected function createRequestParser(): RequestParserInterface
+    {
+        return new BrevoRequestParser(new BrevoPayloadConverter());
+    }
+}
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/blocked.json b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/blocked.json
@@ -0,0 +1,17 @@
+{
+    "id": 814119,
+    "email": "example@gmail.com",
+    "message-id": "<202305311400.29297141656@smtp-relay.mailin.fr>",
+    "date": "2023-05-31 16:00:08",
+    "tags": [
+        "tag1",
+        "tag2"
+    ],
+    "tag": "[\"tag1\",\"tag2\"]",
+    "event": "blocked",
+    "subject": "Subject Line",
+    "ts_event": 1685541608,
+    "ts": 1685541608,
+    "reason": "blocked : due to unsubscribed user",
+    "ts_epoch": 1685541608993
+}
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/blocked.php b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/blocked.php
@@ -0,0 +1,11 @@
+<?php
+
+use Symfony\Component\RemoteEvent\Event\Mailer\MailerDeliveryEvent;
+
+$wh = new MailerDeliveryEvent(MailerDeliveryEvent::DROPPED, '<202305311400.29297141656@smtp-relay.mailin.fr>', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true, flags: JSON_THROW_ON_ERROR));
+$wh->setRecipientEmail('example@gmail.com');
+$wh->setTags(['tag1', 'tag2']);
+$wh->setDate(\DateTimeImmutable::createFromFormat('U', 1685541608));
+$wh->setReason('blocked : due to unsubscribed user');
+
+return $wh;
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/click.json b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/click.json
@@ -0,0 +1,18 @@
+{
+    "id": 814119,
+    "email": "example@gmail.com",
+    "message-id": "<202305311408.17112967225@smtp-relay.mailin.fr>",
+    "date": "2023-05-31 16:08:28",
+    "tags": [
+        "welcome",
+        "tag2"
+    ],
+    "tag": "[\"welcome\",\"tag2\"]",
+    "event": "click",
+    "subject": "Subject Line",
+    "sending_ip": "127.0.0.1",
+    "ts": 1685542108,
+    "ts_epoch": 1685542108462,
+    "ts_event": 1685542108,
+    "link": "https://www.google.com"
+}
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/click.php b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/click.php
@@ -0,0 +1,10 @@
+<?php
+
+use Symfony\Component\RemoteEvent\Event\Mailer\MailerEngagementEvent;
+
+$wh = new MailerEngagementEvent(MailerEngagementEvent::CLICK, '<202305311408.17112967225@smtp-relay.mailin.fr>', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true, flags: JSON_THROW_ON_ERROR));
+$wh->setRecipientEmail('example@gmail.com');
+$wh->setTags(['welcome', 'tag2']);
+$wh->setDate(\DateTimeImmutable::createFromFormat('U', 1685542108));
+
+return $wh;
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/complaint.json b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/complaint.json
@@ -0,0 +1,11 @@
+{
+    "event": "complaint",
+    "email": "example@gmail.com",
+    "id": 814119,
+    "date": "2020-10-09 00:00:00",
+    "ts": 1604933619,
+    "message-id": "<201798300811.5787683@smtp-relay.mailin.fr>",
+    "ts_event": 1604933654,
+    "X-Mailin-custom": "some_custom_header",
+    "tags": ["transac_messages"]
+}
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/complaint.php b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/complaint.php
@@ -0,0 +1,10 @@
+<?php
+
+use Symfony\Component\RemoteEvent\Event\Mailer\MailerEngagementEvent;
+
+$wh = new MailerEngagementEvent(MailerEngagementEvent::SPAM, '<201798300811.5787683@smtp-relay.mailin.fr>', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true, flags: JSON_THROW_ON_ERROR));
+$wh->setRecipientEmail('example@gmail.com');
+$wh->setTags(['transac_messages']);
+$wh->setDate(\DateTimeImmutable::createFromFormat('U', 1604933654));
+
+return $wh;
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/defered.json b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/defered.json
@@ -0,0 +1,16 @@
+{
+    "event":"deferred",
+    "email": "example@domain.com",
+    "id": 814119,
+    "date": "2020-10-09 00:00:00",
+    "ts": 1604933619,
+    "message-id": "<202305311400.29297141656@smtp-relay.mailin.fr>",
+    "ts_event": 1604933654,
+    "subject": "My first Transactional",
+    "X-Mailin-custom": "some_custom_header",
+    "sending_ip": "127.0.0.1",
+    "ts_epoch": 1604933654,
+    "template_id": 22,
+    "tags": ["transac_messages"],
+    "reason": "spam"
+}
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/defered.php b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/defered.php
@@ -0,0 +1,11 @@
+<?php
+
+use Symfony\Component\RemoteEvent\Event\Mailer\MailerDeliveryEvent;
+
+$wh = new MailerDeliveryEvent(MailerDeliveryEvent::DEFERRED, '<202305311400.29297141656@smtp-relay.mailin.fr>', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true, flags: JSON_THROW_ON_ERROR));
+$wh->setRecipientEmail('example@domain.com');
+$wh->setTags(['transac_messages']);
+$wh->setDate(\DateTimeImmutable::createFromFormat('U', 1604933654));
+$wh->setReason('spam');
+
+return $wh;
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/delivered.json b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/delivered.json
@@ -0,0 +1,18 @@
+{
+    "id": 814119,
+    "email": "example@gmail.com",
+    "message-id": "<202305311328.81899448177@smtp-relay.mailin.fr>",
+    "date": "2023-05-31 15:28:33",
+    "tags": [
+        "tag1",
+        "tag2"
+    ],
+    "tag": "[\"tag1\",\"tag2\"]",
+    "event": "delivered",
+    "subject": "Subject Line",
+    "sending_ip": "127.0.0.1",
+    "ts_event": 1685539713,
+    "ts": 1685539713,
+    "reason": "sent",
+    "ts_epoch": 1685539713018
+}
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/delivered.php b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/delivered.php
@@ -0,0 +1,10 @@
+<?php
+
+use Symfony\Component\RemoteEvent\Event\Mailer\MailerDeliveryEvent;
+
+$wh = new MailerDeliveryEvent(MailerDeliveryEvent::DELIVERED, '<202305311328.81899448177@smtp-relay.mailin.fr>', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true, flags: JSON_THROW_ON_ERROR));
+$wh->setRecipientEmail('example@gmail.com');
+$wh->setTags(['tag1', 'tag2']);
+$wh->setDate(\DateTimeImmutable::createFromFormat('U', 1685539713));
+
+return $wh;
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/error.json b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/error.json
@@ -0,0 +1,14 @@
+{
+    "event": "invalid_email",
+    "email": "example@gmail.com",
+    "id": 814119,
+    "date": "2020-10-09 00:00:00",
+    "ts": 1604933619,
+    "message-id": "<201798300811.5787683@smtp-relay.mailin.fr>",
+    "ts_event": 1604933654,
+    "subject": "My first Transactional",
+    "X-Mailin-custom": "some_custom_header",
+    "template_id": 22,
+    "tags": ["transac_messages"],
+    "ts_epoch": 1604933623
+}
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/error.php b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/error.php
@@ -0,0 +1,10 @@
+<?php
+
+use Symfony\Component\RemoteEvent\Event\Mailer\MailerDeliveryEvent;
+
+$wh = new MailerDeliveryEvent(MailerDeliveryEvent::DROPPED, '<201798300811.5787683@smtp-relay.mailin.fr>', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true, flags: JSON_THROW_ON_ERROR));
+$wh->setRecipientEmail('example@gmail.com');
+$wh->setTags(['transac_messages']);
+$wh->setDate(\DateTimeImmutable::createFromFormat('U', 1604933654));
+
+return $wh;
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/hard_bounce.json b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/hard_bounce.json
@@ -0,0 +1,18 @@
+{
+    "id": 814119,
+    "email": "example@gmail.com",
+    "message-id": "<202305311437.85220493321@smtp-relay.mailin.fr>",
+    "date": "2023-05-31 16:37:07",
+    "tags": [
+        "welcome",
+        "tag2"
+    ],
+    "tag": "[\"welcome\",\"tag2\"]",
+    "event": "hard_bounce",
+    "subject": "Subject Line",
+    "sending_ip": "127.0.0.1",
+    "ts_event": 1685543827,
+    "ts": 1685543827,
+    "reason": "550-5.1.1 The email account that you tried to reach does not exist. Please try\n   550-5.1.1 double-checking the recipient's email address for typos or\n   550-5.1.1 unnecessary spaces. Learn more at\n   550 5.1.1  https://support.google.com/mail/?p=NoSuchUser g14-20020a5d698e000000b0030aefbb8608si2668200wru.496 - gsmtp",
+    "ts_epoch": 1685543827372
+}
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/hard_bounce.php b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/hard_bounce.php
@@ -0,0 +1,11 @@
+<?php
+
+use Symfony\Component\RemoteEvent\Event\Mailer\MailerDeliveryEvent;
+
+$wh = new MailerDeliveryEvent(MailerDeliveryEvent::BOUNCE, '<202305311437.85220493321@smtp-relay.mailin.fr>', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true, flags: JSON_THROW_ON_ERROR));
+$wh->setRecipientEmail('example@gmail.com');
+$wh->setTags(['welcome', 'tag2']);
+$wh->setDate(\DateTimeImmutable::createFromFormat('U', 1685543827));
+$wh->setReason("550-5.1.1 The email account that you tried to reach does not exist. Please try\n   550-5.1.1 double-checking the recipient's email address for typos or\n   550-5.1.1 unnecessary spaces. Learn more at\n   550 5.1.1  https://support.google.com/mail/?p=NoSuchUser g14-20020a5d698e000000b0030aefbb8608si2668200wru.496 - gsmtp");
+
+return $wh;
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/invalid_email.json b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/invalid_email.json
@@ -0,0 +1,14 @@
+{
+    "event": "invalid_email",
+    "email": "example@gmail.com",
+    "id": 625895,
+    "date": "2020-10-09 00:00:00",
+    "ts": 1604933619,
+    "message-id": "<201798300811.5787683@smtp-relay.mailin.fr>",
+    "ts_event": 1604933654,
+    "subject": "My first Transactional",
+    "X-Mailin-custom": "some_custom_header",
+    "template_id": 22,
+    "tags": ["transac_messages"],
+    "ts_epoch": 1604933623
+}
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/invalid_email.php b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/invalid_email.php
@@ -0,0 +1,10 @@
+<?php
+
+use Symfony\Component\RemoteEvent\Event\Mailer\MailerDeliveryEvent;
+
+$wh = new MailerDeliveryEvent(MailerDeliveryEvent::DROPPED, '<201798300811.5787683@smtp-relay.mailin.fr>', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true, flags: JSON_THROW_ON_ERROR));
+$wh->setRecipientEmail('example@gmail.com');
+$wh->setTags(['transac_messages']);
+$wh->setDate(\DateTimeImmutable::createFromFormat('U', 1604933654));
+
+return $wh;
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/opened.json b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/opened.json
@@ -0,0 +1,18 @@
+{
+    "id": 814119,
+    "email": "example@gmail.com",
+    "message-id": "<202305311408.17112967225@smtp-relay.mailin.fr>",
+    "date": "2023-05-31 16:45:09",
+    "tags": [
+        "welcome",
+        "tag2"
+    ],
+    "tag": "[\"welcome\",\"tag2\"]",
+    "event": "opened",
+    "subject": "Subject Line",
+    "sending_ip": "127.0.0.1",
+    "ts": 1685544309,
+    "ts_epoch": 1685544309368,
+    "ts_event": 1685544309,
+    "link": ""
+}
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/opened.php b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/opened.php
@@ -0,0 +1,10 @@
+<?php
+
+use Symfony\Component\RemoteEvent\Event\Mailer\MailerEngagementEvent;
+
+$wh = new MailerEngagementEvent(MailerEngagementEvent::OPEN, '<202305311408.17112967225@smtp-relay.mailin.fr>', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true, flags: JSON_THROW_ON_ERROR));
+$wh->setRecipientEmail('example@gmail.com');
+$wh->setTags(['welcome', 'tag2']);
+$wh->setDate(\DateTimeImmutable::createFromFormat('U', 1685544309));
+
+return $wh;
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/proxy_open.json b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/proxy_open.json
@@ -0,0 +1,14 @@
+{
+    "event": "proxy_open",
+    "email": "example@gmail.com",
+    "id": 1,
+    "date": "2020-10-09 00:00:00",
+    "message-id": "<201798300811.5787683@relay.domain.com>",
+    "subject": "My first Transactional",
+    "tags": ["transactionalTag"],
+    "sending_ip": "127.0.0.1",
+    "s_epoch": 1534486682000,
+    "template_id": 1,
+    "ts": 1604933654,
+    "ts_event": 1604933654
+}
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/proxy_open.php b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/proxy_open.php
@@ -0,0 +1,10 @@
+<?php
+
+use Symfony\Component\RemoteEvent\Event\Mailer\MailerEngagementEvent;
+
+$wh = new MailerEngagementEvent(MailerEngagementEvent::OPEN, '<201798300811.5787683@relay.domain.com>', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true, flags: JSON_THROW_ON_ERROR));
+$wh->setRecipientEmail('example@gmail.com');
+$wh->setTags(['transactionalTag']);
+$wh->setDate(\DateTimeImmutable::createFromFormat('U', 1604933654));
+
+return $wh;
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/request.json b/src/Symfony/Component/Mailer/Bridge/Brevo/Tests/Webhook/Fixtures/request.json
@@ -0,0 +1,18 @@
+{
+    "id": 814119,
+    "email": "example@gmail.com",
+    "message-id": "<202305311313.92192897094@smtp-relay.mailin.fr>",
+    "date": "2023-05-31 15:13:08",
+    "tags": [
+        "tag1",
+        "tag2"
+    ],
+    "tag": "[\"tag1\",\"tag2\"]",
+    "event": "request",
+    "subject": "Subject Line",
+    "sending_ip": "127.0.0.1",
+    "ts_event": 1685538788,
+    "ts": 1685538788,
+    "reason": "sent",
+    "ts_epoch": 1685538788179
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,4 +4,5 @@ CHANGELOG @@
 .4
     ---
+    * Add support for `RemoteEvent` and `Webhook`
     * Add the bridge as a replacement of the deprecated Sendinblue one