Drop legacy DjrillMessage class

djrill/mail/__init__.py

@@ -1,54 +0,0 @@
-from django.core.mail import EmailMultiAlternatives
-
-from djrill.exceptions import removed_in_djrill_2
-
-
-# DjrillMessage class is deprecated as of 0.2.0, but retained for
-# compatibility with existing code. (New code can just set Mandrill-specific
-# options directly on an EmailMessage or EmailMultiAlternatives object.)
-class DjrillMessage(EmailMultiAlternatives):
-    alternative_subtype = "mandrill"
-
-    def __init__(self, subject='', body='', from_email=None, to=None, bcc=None,
-        connection=None, attachments=None, headers=None, alternatives=None,
-        cc=None, from_name=None, tags=None, track_opens=True,
-        track_clicks=True, preserve_recipients=None):
-
-        removed_in_djrill_2(
-            "DjrillMessage will be removed in Djrill 2.0. "
-            "Use django.core.mail.EmailMultiAlternatives instead."
-        )
-
-        super(DjrillMessage, self).__init__(subject, body, from_email, to, bcc,
-            connection, attachments, headers, alternatives, cc)
-
-        if from_name:
-            self.from_name = from_name
-        if tags:
-            self.tags = self._set_mandrill_tags(tags)
-        if track_opens is not None:
-            self.track_opens = track_opens
-        if track_clicks is not None:
-            self.track_clicks = track_clicks
-        if preserve_recipients is not None:
-            self.preserve_recipients = preserve_recipients
-
-    def _set_mandrill_tags(self, tags):
-        """
-        Check that all tags are below 50 chars and that they do not start
-        with an underscore.
-
-        Raise ValueError if an underscore tag is passed in to
-        alert the user. Any tag over 50 chars is left out of the list.
-        """
-        tag_list = []
-
-        for tag in tags:
-            if len(tag) <= 50 and not tag.startswith("_"):
-                tag_list.append(tag)
-            elif tag.startswith("_"):
-                raise ValueError(
-                    "Tags starting with an underscore are reserved for "
-                    "internal use and will cause errors with Mandrill's API")
-
-        return tag_list

djrill/tests/test_legacy.py

@@ -8,7 +8,6 @@ from django.test import TestCase
 
 from djrill import MandrillAPIError, NotSupportedByMandrillError
 from djrill.exceptions import RemovedInDjrill2
-from djrill.mail import DjrillMessage
 from djrill.tests.mock_backend import DjrillBackendMockAPITestCase
 from djrill.tests.utils import reset_warning_registry
 
@@ -37,12 +36,6 @@ class DjrillBackendDeprecationTests(DjrillBackendMockAPITestCase):
         self.assertEqual(data['message']['global_merge_vars'],
                          [{'name': 'DATE', 'content': "2022-10-11 00:00:00"}])
 
-    def test_deprecated_djrill_message_class(self):
-        """Djrill 0.2 deprecated DjrillMessage; 2.0 will drop it"""
-        self.assertWarnsMessage(DeprecationWarning,
-                                "DjrillMessage will be removed in Djrill 2.0",
-                                DjrillMessage)
-
     def test_deprecated_djrill_backend_http_error(self):
         """Djrill 0.2 deprecated DjrillBackendHTTPError; 2.0 will drop it"""
         def try_import():
@@ -72,81 +65,6 @@ class DjrillBackendDeprecationTests(DjrillBackendMockAPITestCase):
                          msg="Unexpected warnings %r" % [str(w) for w in relevant_warnings])
 
 
-class DjrillMessageTests(TestCase):
-    """Test the DjrillMessage class (deprecated as of Djrill v0.2.0)
-
-    Maintained for compatibility with older code.
-
-    """
-
-    def run(self, result=None):
-        with warnings.catch_warnings():
-            # DjrillMessage deprecation is tested in test_deprecated_djrill_message_class above
-            warnings.filterwarnings('ignore', category=RemovedInDjrill2,
-                                    message="DjrillMessage will be removed in Djrill 2.0")
-
-    def setUp(self):
-        self.subject = "Djrill baby djrill."
-        self.from_name = "Tarzan"
-        self.from_email = "test@example"
-        self.to = ["King Kong <kingkong@example.com>",
-                   "Cheetah <cheetah@example.com", "bubbles@example.com"]
-        self.text_content = "Wonderful fallback text content."
-        self.html_content = "<h1>That's a nice HTML email right there.</h1>"
-        self.headers = {"Reply-To": "tarzan@example.com"}
-        self.tags = ["track", "this"]
-
-    def test_djrill_message_success(self):
-        msg = DjrillMessage(self.subject, self.text_content, self.from_email,
-            self.to, tags=self.tags, headers=self.headers,
-            from_name=self.from_name)
-
-        self.assertIsInstance(msg, DjrillMessage)
-        self.assertEqual(msg.body, self.text_content)
-        self.assertEqual(msg.recipients(), self.to)
-        self.assertEqual(msg.tags, self.tags)
-        self.assertEqual(msg.extra_headers, self.headers)
-        self.assertEqual(msg.from_name, self.from_name)
-
-    def test_djrill_message_html_success(self):
-        msg = DjrillMessage(self.subject, self.text_content, self.from_email,
-            self.to, tags=self.tags)
-        msg.attach_alternative(self.html_content, "text/html")
-
-        self.assertEqual(msg.alternatives[0][0], self.html_content)
-
-    def test_djrill_message_tag_failure(self):
-        with self.assertRaises(ValueError):
-            DjrillMessage(self.subject, self.text_content, self.from_email,
-                self.to, tags=["_fail"])
-
-    def test_djrill_message_tag_skip(self):
-        """
-        Test that tags over 50 chars are not included in the tags list.
-        """
-        tags = ["works", "awesomesauce",
-                "iwilltestmycodeiwilltestmycodeiwilltestmycodeiwilltestmycode"]
-        msg = DjrillMessage(self.subject, self.text_content, self.from_email,
-            self.to, tags=tags)
-
-        self.assertIsInstance(msg, DjrillMessage)
-        self.assertIn(tags[0], msg.tags)
-        self.assertIn(tags[1], msg.tags)
-        self.assertNotIn(tags[2], msg.tags)
-
-    def test_djrill_message_no_options(self):
-        """DjrillMessage with only basic EmailMessage options should work"""
-        msg = DjrillMessage(self.subject, self.text_content,
-            self.from_email, self.to) # no Mandrill-specific options
-
-        self.assertIsInstance(msg, DjrillMessage)
-        self.assertEqual(msg.body, self.text_content)
-        self.assertEqual(msg.recipients(), self.to)
-        self.assertFalse(hasattr(msg, 'tags'))
-        self.assertFalse(hasattr(msg, 'from_name'))
-        self.assertFalse(hasattr(msg, 'preserve_recipients'))
-
-
 class DjrillLegacyExceptionTests(TestCase):
     def test_DjrillBackendHTTPError(self):
         """MandrillApiError was DjrillBackendHTTPError in 0.2.0"""

docs/history.rst

@@ -48,6 +48,11 @@ Removed DjrillAdminSite
   (Do this only if you changed to SimpleAdminConfig for Djrill, and aren't
   creating custom admin sites for any other Django apps you use.)
 
+Removed DjrillMessage class
+  The ``DjrillMessage`` class has not been needed since Djrill 0.2.
+  You should replace any uses of it with the standard
+  :class:`~django.core.mail.EmailMessage` class.
+
 
 **Dates in merge data and other attributes**
 
@@ -67,15 +72,6 @@ or datetime values used in any Mandrill message attributes other
 than `send_at`. See :ref:`formatting-merge-data` for other options.
 
 
-**DjrillMessage class**
-
-The ``DjrillMessage`` class has not been needed since Djrill 0.2.
-You can simply set Djrill message attributes on any Django
-:class:`~django.core.mail.EmailMessage` object.
-Djrill 1.4 will report a DeprecationWarning if you are still
-using DjrillMessage.
-
-
 **DjrillBackendHTTPError**
 
 The ``DjrillBackendHTTPError`` exception was replaced in Djrill 0.3