Add optional return_json flag with Django/global fallback

Author: m-ewura

postmark/core.py

@@ -504,7 +504,7 @@ def to_json_message(self):
 
         return json_message
 
-    def send(self, test=None):
+    def send(self, test=None, return_json=None):
         '''
         Send the email through the Postmark system.
         Pass test=True to just print out the resulting
@@ -537,6 +537,21 @@ def send(self, test=None):
         else:
             endpoint_url = __POSTMARK_URL__ + 'email'
 
+        """
+        Args:
+            return_json (bool | None):
+                True  -> return parsed JSON
+                False -> return True/False
+                None  -> fallback to settings.POSTMARK_RETURN_JSON (default False)
+        """
+
+        if return_json is None:
+            try:
+                from django.conf import settings as django_settings
+                return_json = getattr(django_settings, "POSTMARK_RETURN_JSON", False)
+            except ImportError:
+                return_json = False
+
         # Set up the url Request
         req = Request(
             endpoint_url,
@@ -558,7 +573,7 @@ def send(self, test=None):
             if result.code == 200:
                 parsed = json.loads(jsontxt)
                 self.message_id = parsed.get("MessageID", None)
-                return parsed
+                return parsed if return_json else True
             else:
                 raise PMMailSendException('Return code %d: %s' % (result.code, result.msg))
         except HTTPError as err:
@@ -677,7 +692,7 @@ def _check_values(self):
 
             message._check_values()
 
-    def send(self, test=None):
+    def send(self, test=None, return_json=None):
         # Has one of the messages caused an inactive recipient error?
         inactive_recipient = False
 
@@ -692,6 +707,21 @@ def send(self, test=None):
             except ImportError:
                 pass
 
+        """
+        Args:
+            return_json (bool | None):
+                True  -> return parsed JSON
+                False -> return True/False
+                None  -> fallback to settings.POSTMARK_RETURN_JSON (default False)
+        """
+
+        if return_json is None:
+            try:
+                from django.conf import settings as django_settings
+                return_json = getattr(django_settings, "POSTMARK_RETURN_JSON", False)
+            except ImportError:
+                return_json = False
+
         # Split up into groups of 500 messages for sending
         for messages in _chunks(self.messages, PMBatchMail.MAX_MESSAGES):
             json_message = []
@@ -730,7 +760,7 @@ def send(self, test=None):
                     results = json.loads(jsontxt)
                     for i, res in enumerate(results):
                         self.__messages[i].message_id = res.get("MessageID", None)
-                    return results
+                    return results if return_json else True
                 else:
                     raise PMMailSendException('Return code %d: %s' % (result.code, result.msg))
             except HTTPError as err: