PR fededback: Refactor /send endpoint, default to unknown status, remove merge data/metadata, implement set extra headers and set esp extra, adjust exception handling, set inbound timestamp to None

Author: paul-oms

anymail/backends/mailpace.py

@@ -21,7 +21,7 @@ def __init__(self, **kwargs):
             "api_url",
             esp_name=esp_name,
             kwargs=kwargs,
-            default="https://app.mailpace.com/api/v1/send",
+            default="https://app.mailpace.com/api/v1/",
         )
         if not api_url.endswith("/"):
             api_url += "/"
@@ -37,7 +37,7 @@ def raise_for_status(self, response, payload, message):
 
     def parse_recipient_status(self, response, payload, message):
         # Prepare the dict by setting everything to queued without a message id
-        unknown_status = AnymailRecipientStatus(message_id=None, status="queued")
+        unknown_status = AnymailRecipientStatus(message_id=None, status="unknown")
         recipient_status = CaseInsensitiveCasePreservingDict(
             {recip.addr_spec: unknown_status for recip in payload.to_cc_and_bcc_emails}
         )
@@ -122,10 +122,11 @@ def __init__(self, message, defaults, backend, *args, **kwargs):
         }
         self.server_token = backend.server_token  # esp_extra can override
         self.to_cc_and_bcc_emails = []
-        self.merge_data = None
-        self.merge_metadata = None
         super().__init__(message, defaults, backend, headers=headers, *args, **kwargs)
 
+    def get_api_endpoint(self):
+        return "send"
+
     def get_request_params(self, api_url):
         params = super().get_request_params(api_url)
         params["headers"]["MailPace-Server-Token"] = self.server_token
@@ -159,6 +160,12 @@ def set_reply_to(self, emails):
             reply_to = ", ".join([email.address for email in emails])
             self.data["replyto"] = reply_to
 
+    def set_extra_headers(self, headers):
+        if "list-unsubscribe" in headers:
+            self.data["list_unsubscribe"] = headers.pop("list-unsubscribe")
+        if headers:
+            self.unsupported_features("extra_headers (other than List-Unsubscribe)")
+
     def set_text_body(self, body):
         self.data["textbody"] = body
 
@@ -188,3 +195,8 @@ def set_tags(self, tags):
                 self.data["tags"] = tags[0]
             else:
                 self.data["tags"] = tags
+
+    def set_esp_extra(self, extra):
+        self.data.update(extra)
+        # Special handling for 'server_token':
+        self.server_token = self.data.pop("server_token", self.server_token)

anymail/webhooks/mailpace.py

@@ -51,14 +51,14 @@ class MailPaceTrackingWebhookView(MailPaceBaseWebhookView):
     webhook_key = None
 
     def __init__(self, **kwargs):
-        try:
-            self.webhook_key = get_anymail_setting(
-                "webhook_key", esp_name=self.esp_name, kwargs=kwargs, allow_bare=True
-            )
-            self.warn_if_no_basic_auth = False
-        except AnymailConfigurationError:
-            self.webhook_key = None
-            self.warn_if_no_basic_auth = True
+        self.webhook_key = get_anymail_setting(
+            "webhook_key",
+            esp_name=self.esp_name,
+            kwargs=kwargs,
+            allow_bare=True,
+            default=None,
+        )
+        self.warn_if_no_basic_auth = self.webhook_key is None
 
         super().__init__(**kwargs)
 
@@ -81,10 +81,10 @@ def validate_request(self, request):
             try:
                 signature_base64 = request.headers["X-MailPace-Signature"]
                 signature = base64.b64decode(signature_base64)
-            except (KeyError, binascii.Error):
+            except (KeyError, binascii.Error) as error:
                 raise AnymailWebhookValidationFailure(
                     "MailPace webhook called with invalid or missing signature"
-                )
+                ) from error
 
             verify_key_base64 = self.webhook_key
 
@@ -98,9 +98,6 @@ def validate_request(self, request):
                 raise AnymailWebhookValidationFailure(
                     "MailPace webhook called with incorrect signature"
                 )
-        else:
-            return True
-            # No webhook key set
 
     def esp_to_anymail_event(self, esp_event):
         event_type = self.event_record_types.get(esp_event["event"], EventType.UNKNOWN)
@@ -138,7 +135,7 @@ def esp_to_anymail_event(self, esp_event):
 
         return AnymailInboundEvent(
             event_type=EventType.INBOUND,
-            timestamp=timezone.now(),
+            timestamp=None,
             event_id=esp_event.get("id", None),
             esp_event=esp_event,
             message=message,

tests/test_mailpace_backend.py

@@ -56,7 +56,7 @@ def test_send_mail(self):
             ["to@example.com"],
             fail_silently=False,
         )
-        self.assert_esp_called("send/")
+        self.assert_esp_called("https://app.mailpace.com/api/v1/send")
         headers = self.get_api_call_headers()
         self.assertEqual(headers["MailPace-Server-Token"], "test_server_token")
         data = self.get_api_call_json()