Mailtrap: add webhook tests and update test configs

anymail · Nov 17, 2024 · c2a7387 · c2a7387
1 parent b45a10a
commit c2a7387
Show file tree

Hide file tree

Showing 7 changed files with 362 additions and 2 deletions.
diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml
@@ -44,6 +44,7 @@ jobs:
           - { tox: django41-py310-mailersend, python: "3.12" }
           - { tox: django41-py310-mailgun, python: "3.12" }
           - { tox: django41-py310-mailjet, python: "3.12" }
+          - { tox: django41-py310-mailtrap, python: "3.12" }
           - { tox: django41-py310-mandrill, python: "3.12" }
           - { tox: django41-py310-postal, python: "3.12" }
           - { tox: django41-py310-postmark, python: "3.12" }

diff --git a/README.rst b/README.rst
@@ -31,6 +31,7 @@ Anymail currently supports these ESPs:
 * **MailerSend**
 * **Mailgun** (Sinch transactional email)
 * **Mailjet** (Sinch transactional email)
+* **Mailtrap**
 * **Mandrill** (MailChimp transactional email)
 * **Postal** (self-hosted ESP)
 * **Postmark** (ActiveCampaign transactional email)

diff --git a/anymail/backends/mailtrap.py b/anymail/backends/mailtrap.py
@@ -58,7 +58,9 @@ def __init__(
             "Api-Token": backend.api_token,
             "Content-Type": "application/json",
             "Accept": "application/json",
+            "User-Agent": "django-anymail (https://github.com/anymail/django-anymail)",
         }
+        # Yes, the parent sets this, but setting it here, too, gives type hints
         self.backend = backend
         self.metadata = None
         super().__init__(

diff --git a/anymail/webhooks/mailtrap.py b/anymail/webhooks/mailtrap.py
@@ -59,7 +59,6 @@ def parse_events(self, request):
         "click": EventType.CLICKED,
         "bounce": EventType.BOUNCED,
         "soft bounce": EventType.DEFERRED,
-        "blocked": EventType.REJECTED,
         "spam": EventType.COMPLAINED,
         "unsubscribe": EventType.UNSUBSCRIBED,
         "reject": EventType.REJECTED,
@@ -73,6 +72,8 @@ def parse_events(self, request):
         "spam": RejectReason.SPAM,
         "unsubscribe": RejectReason.UNSUBSCRIBED,
         "reject": RejectReason.BLOCKED,
+        "suspension": RejectReason.OTHER,
+        "soft bounce": RejectReason.OTHER,
     }
 
     def esp_to_anymail_event(self, esp_event: MailtrapEvent):
@@ -91,7 +92,7 @@ def esp_to_anymail_event(self, esp_event: MailtrapEvent):
             event_id=esp_event.get("event_id", None),
             recipient=esp_event.get("email", None),
             reject_reason=reject_reason,
-            mta_response=esp_event.get("response_code", None),
+            mta_response=esp_event.get("response", None),
             tags=tags,
             metadata=custom_variables,
             click_url=esp_event.get("url", None),

diff --git a/pyproject.toml b/pyproject.toml
@@ -26,6 +26,7 @@ keywords = [
     "Brevo", "SendinBlue",
     "MailerSend",
     "Mailgun", "Mailjet", "Sinch",
+    "Mailtrap",
     "Mandrill", "MailChimp",
     "Postal",
     "Postmark", "ActiveCampaign",