Return Postmark API response in send() and add tests

Author: m-ewura

postmark/core.py

@@ -556,8 +556,9 @@ def send(self, test=None):
             jsontxt = result.read().decode('utf8')
             result.close()
             if result.code == 200:
-                self.message_id = json.loads(jsontxt).get('MessageID', None)
-                return True
+                parsed = json.loads(jsontxt)
+                self.message_id = parsed.get("MessageID", None)
+                return parsed
             else:
                 raise PMMailSendException('Return code %d: %s' % (result.code, result.msg))
         except HTTPError as err:
@@ -729,6 +730,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
                 else:
                     raise PMMailSendException('Return code %d: %s' % (result.code, result.msg))
             except HTTPError as err:

tests.py

@@ -20,6 +20,9 @@
 
 import mock
 
+import django
+from unittest.mock import patch, MagicMock
+
 from postmark import (
     PMBatchMail, PMMail, PMMailInactiveRecipientException,
     PMMailUnprocessableEntityException, PMMailServerErrorException,
@@ -29,6 +32,79 @@
 from django.conf import settings
 
 
+if not settings.configured:
+    settings.configure(
+        POSTMARK_TRACK_OPENS=False,
+        POSTMARK_API_KEY="dummy",
+        POSTMARK_SENDER="test@example.com",
+    )
+    django.setup()
+
+def make_fake_response(payload, code=200):
+    """Helper to fake an HTTP response object."""
+    mock = MagicMock()
+    mock.code = code
+    mock.read.return_value = json.dumps(payload).encode("utf-8")
+    mock.close.return_value = None
+    return mock
+
+@patch("postmark.core.urlopen")
+def test_mail_returns_result(mock_urlopen):
+    # Fake Postmark single send response
+    fake_payload = {
+        "To": "receiver@example.com",
+        "SubmittedAt": "2025-09-18T10:00:00Z",
+        "MessageID": "abc-123",
+        "ErrorCode": 0,
+        "Message": "OK"
+    }
+    mock_urlopen.return_value = make_fake_response(fake_payload)
+
+    mail = PMMail(
+        api_key="test-api-key",
+        sender="sender@example.com",
+        to="receiver@example.com",
+        subject="Hello",
+        text_body="Testing single mail return",
+    )
+    result = mail.send()
+
+    assert isinstance(result, dict)
+    assert result["ErrorCode"] == 0
+    assert result["Message"] == "OK"
+
+
+@patch("postmark.core.urlopen")
+def test_batch_mail_returns_results(mock_urlopen):
+    # Fake batch response
+    fake_payload = [
+        {
+            "To": "receiver@example.com",
+            "SubmittedAt": "2025-09-18T10:00:00Z",
+            "MessageID": "abc-123",
+            "ErrorCode": 0,
+            "Message": "OK",
+        }
+    ]
+    mock_urlopen.return_value = make_fake_response(fake_payload)
+
+    # Build PMMail objects
+    message = PMMail(
+        api_key="test-api-key",
+        sender="sender@example.com",
+        to="receiver@example.com",
+        subject="Hello",
+        text_body="Testing batch return",
+    )
+
+    # Pass list of PMMail objects to PMBatchMail
+    batch = PMBatchMail(api_key="test-api-key", messages=[message])
+    results = batch.send()
+
+    assert isinstance(results, list)
+    assert results[0]["ErrorCode"] == 0
+
+
 class PMMailTests(unittest.TestCase):
     def test_406_error_inactive_recipient(self):
         json_payload = BytesIO()