Mailgun: treat temporary failure as deferred in tracking webhook

Map Mailgun severity: temporary failure event to Anymail "deferred" event, to distinguish it from severity: permanent failures which will show up as Anymail "bounced".

Also remap Mailgun reason: generic failure to Anymail "other" reject reason (rather than "bounced").

Closes #130

Author: costela

anymail/webhooks/mailgun.py

@@ -87,16 +87,20 @@ def parse_events(self, request):
         # (these appear in webhook doc examples, but aren't actually documented anywhere)
         "bounce": RejectReason.BOUNCED,
         "suppress-bounce": RejectReason.BOUNCED,
-        "generic": RejectReason.BOUNCED,  # ??? appears to be used for any temporary failure?
+        "generic": RejectReason.OTHER,  # ??? appears to be used for any temporary failure?
+    }
+
+    severities = {
+        # Remap some event types based on "severity" payload field
+        (EventType.BOUNCED, 'temporary'): EventType.DEFERRED
     }
 
     def esp_to_anymail_event(self, esp_event):
         event_data = esp_event.get('event-data', {})
 
-        try:
-            event_type = self.event_types[event_data['event']]
-        except KeyError:
-            event_type = EventType.UNKNOWN
+        event_type = self.event_types.get(event_data['event'], EventType.UNKNOWN)
+
+        event_type = self.severities.get((EventType.BOUNCED, event_data.get('severity')), event_type)
 
         # Use signature.token for event_id, rather than event_data.id,
         # because the latter is only "guaranteed to be unique within a day".

tests/test_mailgun_webhooks.py

@@ -251,12 +251,52 @@ def test_failed_temporary_event(self):
         kwargs = self.assert_handler_called_once_with(self.tracking_handler, sender=MailgunTrackingWebhookView,
                                                       event=ANY, esp_name='Mailgun')
         event = kwargs['event']
-        self.assertEqual(event.event_type, "bounced")
+        self.assertEqual(event.event_type, "deferred")
         self.assertEqual(event.recipient, "[email protected]")
-        self.assertEqual(event.reject_reason, "bounced")
+        self.assertEqual(event.reject_reason, "other")
         self.assertEqual(event.description, "No MX for nomx.example.com")
         self.assertEqual(event.mta_response, "No MX for nomx.example.com")
 
+    def test_failed_greylisted_event(self):
+        raw_event = mailgun_sign_payload({
+            "event-data": {
+                "event": "failed",
+                "severity": "temporary",
+                "reason": "greylisted",
+                "timestamp": 1534111899.659519,
+                "log-level": "warn",
+                "message": {
+                    "headers": {
+                        "to": "[email protected]",
+                        "message-id": "[email protected]",
+                        "from": "Test Sender ",
+                        "subject": "Testing"
+                    },
+                },
+                "recipient": "[email protected]",
+                "delivery-status": {
+                    "mx-host": "mx.example.com",
+                    "attempt-no": 1,
+                    "description": "Recipient address rejected: Greylisted",
+                    "session-seconds": 0.0,
+                    "retry-seconds": 300,
+                    "code": 450,
+                    "message": "Recipient address rejected: Greylisted"
+                }
+            },
+        })
+        response = self.client.post('/anymail/mailgun/tracking/',
+                                    data=json.dumps(raw_event), content_type='application/json')
+        self.assertEqual(response.status_code, 200)
+        kwargs = self.assert_handler_called_once_with(self.tracking_handler, sender=MailgunTrackingWebhookView,
+                                                      event=ANY, esp_name='Mailgun')
+        event = kwargs['event']
+        self.assertEqual(event.event_type, "deferred")
+        self.assertEqual(event.recipient, "[email protected]")
+        self.assertEqual(event.reject_reason, "other")
+        self.assertEqual(event.description, "Recipient address rejected: Greylisted")
+        self.assertEqual(event.mta_response, "Recipient address rejected: Greylisted")
+
     def test_rejected_event(self):
         # (The "rejected" event is documented and appears in Mailgun dashboard logs,
         # but it doesn't appear to be delivered through webhooks as of 8/2018.)