Fix: Ensure msg.send() returns boolean (#37)

* fix: Ensure `msg.send()` returns boolean

Converted `msg.send()` result to a boolean in `._send_and_log_email()` for clarity and consistency.

- Updated `msg.send()` handling to return `True` for success and `False` otherwise.
- Adjusted related tests to reflect the updated behavior.
- Added new test cases to verify boolean conversion of `msg.send()` results.

* chore: Bump version to 2.7.3

Author: christoph-teichmeister

CHANGES.md

@@ -1,5 +1,8 @@
 # Changelog
 
+**2.7.3** (2025-06-24)
+  * Convert `msg.send()` result to boolean in `._send_and_log_email()`
+
 **2.7.2** (2025-05-30)
   * Replaced freezegun with time_machine for tests
   * Maintenance updates via ambient-package-update
@@ -19,131 +22,131 @@
 **2.6.2** (2025-04-03)
   * Maintenance updates via ambient-package-update
 
-* *2.6.1* (2025-03-18)
+**2.6.1** (2025-03-18)
   * Fixed a bug where translations were not deactivated after sending an email
 
-* *2.6.0* (2025-03-17)
+**2.6.0** (2025-03-17)
   * Added check for email structure validity
 
-* *2.5.1* (2025-02-15)
+**2.5.1** (2025-02-15)
   * Maintenance updates via ambient-package-update
 
-* *2.5.0* (2024-12-03)
+**2.5.0** (2024-12-03)
   * Added connection param to `BaseEmailService` (Thx to @sk-rama)
 
-* *2.4.3* (2024-11-15)
+**2.4.3** (2024-11-15)
   * Move logic to render HTML and text content to dedicated methods
 
-* *2.4.2* (2024-11-15)
+**2.4.2** (2024-11-15)
   * Internal updates via `ambient-package-update`
 
-* *2.4.1* (2024-10-14)
+**2.4.1** (2024-10-14)
   * Added Python 3.13 support
   * Added Djade linter to pre-commit
   * Improved GitHub action triggers
   * Updated dev dependencies and linters
 
-* *2.4.0* (2024-09-11)
+**2.4.0** (2024-09-11)
   * Allow custom subject delimiter
 
-* *2.3.3* (2024-09-11)
+**2.3.3** (2024-09-11)
   * Fixed coverage setup due to GitHub changes
 
-* *2.3.2* (2024-09-11)
+**2.3.2** (2024-09-11)
   * Fixed package name
 
-* *2.3.1* (2024-08-12)
+**2.3.1** (2024-08-12)
   * Fixed test matrix
 
-* *2.3.0* (2024-08-12)
+**2.3.0** (2024-08-12)
   * Added Django 5.1 support
 
-* *2.2.2* (2024-07-18)
+**2.2.2** (2024-07-18)
   * Added SECURITY.md
   * Updated linters
   * Internal updates via `ambient-package-update`
 
-* *2.2.1* (2024-07-16)
+**2.2.1** (2024-07-16)
   * Updated GitHub actions
 
-* *2.2.0* (2024-07-15)
+**2.2.0** (2024-07-15)
   * Dropped Python 3.8 support
   * Added multiple ruff linters
 
-* *2.1.3* (2024-06-21)
+**2.1.3** (2024-06-21)
   * Linted docs with `blacken-docs` via `ambient-package-update`
 
-* *2.1.2* (2024-06-14)
+**2.1.2** (2024-06-14)
   * Internal updates via `ambient-package-update`
 
-* *2.1.1* (2024-05-31)
+**2.1.1** (2024-05-31)
   * Changed log-level to "info" for successful dispatching
   * Improved configuration docs
 
-* *2.1.0* (2024-05-27)
+**2.1.0** (2024-05-27)
   * Added `ThreadEmailService` for simple async sending of emails
   * Added basic logging with privacy configuration to mail class
   * Restructured documentation
   * Restructured unit-tests
   * Minor test improvements
 
-* *2.0.0* (2024-04-11)
+**2.0.0** (2024-04-11)
   * Dropped Django 3.2 & 4.1 support (via `ambient-package-update`)
   * Internal updates via `ambient-package-update`
 
-* *1.3.0** (2023-12-04)
+**1.3.0** (2023-12-04)
   * Added Django 5.0 support
 
-* *1.2.5** (2023-11-13)
+**1.2.5** (2023-11-13)
   * Fixed wrong import path in docs
 
-* *1.2.4** (2023-11-03)
+**1.2.4** (2023-11-03)
   * Switched formatter from `black` to `ruff`
 
-* *1.2.3** (2023-10-20)
+**1.2.3** (2023-10-20)
   * Linter updaters including code adjustments
   * Updates from ambient updater
 
-* *1.2.2** (2023-10-04)
+**1.2.2** (2023-10-04)
   * Dependency to ambient updater updated
 
-* *1.2.1** (2023-10-04)
+**1.2.1** (2023-10-04)
   * Downgraded Python to 3.11 for readthedocs.org
 
-* *1.2.0** (2023-10-04)
+**1.2.0** (2023-10-04)
   * Added Python 3.12 support
   * Updated internal linter packages
 
-* *1.1.6** (2023-09-08)
+**1.1.6** (2023-09-08)
   * Metadata update via ambient package updater
 
-* *1.1.5** (2023-09-08)
+**1.1.5** (2023-09-08)
   * Metadata update via ambient package updater
   * Cleaned up test matrix
 
-* **1.1.4** (2023-08-31)
+**1.1.4** (2023-08-31)
   * Fixed downloads badge
 
-* **1.1.3** (2023-08-31)
+**1.1.3** (2023-08-31)
   * Improved type-hinting for constructor of `BaseEmailServiceFactory` and `BaseEmailService`
 
-* **1.1.2** (2023-08-14)
+**1.1.2** (2023-08-14)
   * Updated linters and add more strict linting rules
 
-* **1.1.1** (2023-05-10)
+**1.1.1** (2023-05-10)
   * Updated readme "maintenance" section
   * Updated package linters
   * Added release scripts for windows and UNIX
 
-* **1.1.0** (2023-05-04)
+**1.1.0** (2023-05-04)
   * Support for Django 4.2 added
 
-* **1.0.2** (2023-05-04)
+**1.0.2** (2023-05-04)
   * Updated documentation
 
-* **1.0.1** (2023-05-03)
+**1.0.1** (2023-05-03)
   * Added missing translations
   * Updated documentation
 
-* **1.0.0** (2023-05-01)
+**1.0.0** (2023-05-01)
   * Release as a separate package at PyPI (was before a part of [ai-django-core](https://pypi.org/project/ai-django-core/))

django_pony_express/__init__.py

@@ -1,3 +1,3 @@
 """Class-based emails including a test suite for Django"""
 
-__version__ = "2.7.2"
+__version__ = "2.7.3"

django_pony_express/services/base.py

@@ -343,7 +343,9 @@ def _send_and_log_email(self, msg: EmailMultiAlternatives) -> bool:
         result = False
         recipients_as_string = " ".join(self.recipient_email_list)
         try:
-            result = msg.send()
+            # msg.send() returns an int: 0 if no recipients exist, 1 if the message sending was successful
+            # Since we want to return a boolean, we check for "== 1" here
+            result = msg.send() == 1
             if PONY_LOG_RECIPIENTS:
                 self._logger.info(_('Email "%s" successfully sent to %s.') % (msg.subject, recipients_as_string))
             else:

tests/services/base/test_base_mail_service.py

@@ -38,7 +38,7 @@ def test_init_connection_regular(self):
         service.template_name = "testapp/test_email.html"
 
         result = service.process()
-        self.assertIs(result, 1)
+        self.assertIs(result, True)
 
         # Assert email was "sent"
         self.assertGreater(len(mail.outbox), 0)
@@ -398,7 +398,7 @@ def test_send_and_log_email_success_privacy_active(self, mock_logger):
         )
 
         mock_logger.info.assert_called_with('Email "The Pony Express" successfully sent.')
-        self.assertEqual(result, 1)
+        self.assertEqual(result, True)
 
     @mock.patch("django_pony_express.services.base.BaseEmailService._logger")
     @mock.patch("django_pony_express.services.base.PONY_LOG_RECIPIENTS", True)
@@ -409,7 +409,7 @@ def test_send_and_log_success_privacy_inactive(self, mock_logger):
         )
 
         mock_logger.info.assert_called_with('Email "The Pony Express" successfully sent to [email protected].')
-        self.assertEqual(result, 1)
+        self.assertEqual(result, True)
 
     @mock.patch.object(EmailMultiAlternatives, "send", side_effect=Exception("Broken pony"))
     @mock.patch("django_pony_express.services.base.BaseEmailService._logger")
@@ -439,6 +439,26 @@ def test_send_and_log_failure_privacy_inactive(self, mock_logger, *args):
         )
         self.assertFalse(result)
 
+    @mock.patch.object(EmailMultiAlternatives, "send", return_value=1)
+    def test_send_and_log_email_returns_true_when_msg_send_returns_one(self, mock_send):
+        service = BaseEmailService(recipient_email_list=["[email protected]"])
+        result = service._send_and_log_email(
+            msg=EmailMultiAlternatives(subject="The Pony Express", to=["[email protected]"])
+        )
+
+        mock_send.assert_called_once()
+        self.assertEqual(result, True)
+
+    @mock.patch.object(EmailMultiAlternatives, "send", return_value=99)
+    def test_send_and_log_email_returns_false_when_msg_send_returns_any_other_number_than_one(self, mock_send):
+        service = BaseEmailService(recipient_email_list=["[email protected]"])
+        result = service._send_and_log_email(
+            msg=EmailMultiAlternatives(subject="The Pony Express", to=["[email protected]"])
+        )
+
+        mock_send.assert_called_once()
+        self.assertEqual(result, False)
+
     def test_process_regular(self):
         email = "[email protected]"
         subject = "Test email"