✨(template) simplify message template type

Author: sdemagny

src/backend/core/api/openapi.json

@@ -2746,8 +2746,7 @@
                         "schema": {
                             "type": "string",
                             "enum": [
-                                "new_message",
-                                "reply",
+                                "message",
                                 "signature"
                             ]
                         }
@@ -3521,8 +3520,7 @@
                         "schema": {
                             "type": "string",
                             "enum": [
-                                "new_message",
-                                "reply",
+                                "message",
                                 "signature"
                             ]
                         }
@@ -6475,8 +6473,7 @@
             "MessageTemplateTypeChoices": {
                 "type": "string",
                 "enum": [
-                    "reply",
-                    "new_message",
+                    "message",
                     "signature"
                 ]
             },

src/backend/core/api/serializers.py

@@ -598,7 +598,9 @@ class MessageRecipientSerializer(serializers.ModelSerializer):
 
     contact = ContactSerializer(read_only=True)
     delivery_status = IntegerChoicesField(
-        choices_class=models.MessageDeliveryStatusChoices, read_only=True, allow_null=True
+        choices_class=models.MessageDeliveryStatusChoices,
+        read_only=True,
+        allow_null=True,
     )
     retry_at = serializers.DateTimeField(read_only=True, allow_null=True)
     delivered_at = serializers.DateTimeField(read_only=True, allow_null=True)

src/backend/core/enums.py

@@ -117,9 +117,8 @@ class MailboxAbilities(models.TextChoices):
 class MessageTemplateTypeChoices(models.IntegerChoices):
     """Defines the possible types of message templates."""
 
-    REPLY = 1, "reply"
-    NEW_MESSAGE = 2, "new_message"
-    SIGNATURE = 3, "signature"
+    MESSAGE = 1, "message"
+    SIGNATURE = 2, "signature"
 
 
 EML_SUPPORTED_MIME_TYPES = ["message/rfc822", "application/eml"]

src/backend/core/migrations/0011_alter_messagetemplate_type.py

@@ -0,0 +1,29 @@
+# Generated by Django 5.1.13 on 2025-10-15 19:05
+
+from django.db import migrations, models
+
+
+def migrate_messagetemplate_type(apps, schema_editor):
+    """Convert the type to the new values.
+    Reply and new message are now message type (1)."""
+    MessageTemplate = apps.get_model('core', 'MessageTemplate')
+    # Set new message type to message type value (1)
+    MessageTemplate.objects.filter(type=2).update(type=1)
+    # Set signature type to new value for signature type (2)
+    MessageTemplate.objects.filter(type=3).update(type=2)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0010_thread_has_archived_alter_user_language'),
+    ]
+
+    operations = [
+        migrations.RunPython(migrate_messagetemplate_type, reverse_code=migrations.RunPython.noop),
+        migrations.AlterField(
+            model_name='messagetemplate',
+            name='type',
+            field=models.SmallIntegerField(choices=[(1, 'message'), (2, 'signature')], default=1, help_text='Type of template (message, signature)', verbose_name='type'),
+        ),
+    ]

src/backend/core/models.py

@@ -1683,8 +1683,8 @@ class MessageTemplate(BaseModel):
     type = models.SmallIntegerField(
         _("type"),
         choices=MessageTemplateTypeChoices.choices,
-        default=MessageTemplateTypeChoices.REPLY,
-        help_text=_("Type of template (reply, new_message, signature)"),
+        default=MessageTemplateTypeChoices.MESSAGE,
+        help_text=_("Type of template (message, signature)"),
     )
 
     is_active = models.BooleanField(

src/backend/core/tests/api/test_admin_maildomains_message_template.py

@@ -80,18 +80,11 @@ def test_list_templates(self, user, maildomain, admin_list_url):
             user=user,
             role=enums.MailDomainAccessRoleChoices.ADMIN,
         )
-        reply_template = factories.MessageTemplateFactory(
-            name="Reply Template",
-            html_body="<p>Reply content</p>",
-            text_body="Reply content",
-            type=enums.MessageTemplateTypeChoices.REPLY,
-            maildomain=maildomain,
-        )
-        new_message_template = factories.MessageTemplateFactory(
-            name="New Message Template",
-            html_body="<p>New message content</p>",
-            text_body="New message content",
-            type=enums.MessageTemplateTypeChoices.NEW_MESSAGE,
+        message_template = factories.MessageTemplateFactory(
+            name="Message Template",
+            html_body="<p>Message content</p>",
+            text_body="Message content",
+            type=enums.MessageTemplateTypeChoices.MESSAGE,
             maildomain=maildomain,
         )
         signature_template = factories.MessageTemplateFactory(
@@ -108,11 +101,10 @@ def test_list_templates(self, user, maildomain, admin_list_url):
         # Test listing all templates
         response = client.get(admin_list_url)
         assert response.status_code == status.HTTP_200_OK
-        assert len(response.data) == 3
+        assert len(response.data) == 2
         templates_by_type = {t["type"]: t for t in response.data}
+        assert templates_by_type["message"]["id"] == str(message_template.id)
         assert templates_by_type["signature"]["id"] == str(signature_template.id)
-        assert templates_by_type["reply"]["id"] == str(reply_template.id)
-        assert templates_by_type["new_message"]["id"] == str(new_message_template.id)
 
         # Test filtering by single type
         response = client.get(admin_list_url, {"type": ["signature"]})
@@ -122,37 +114,22 @@ def test_list_templates(self, user, maildomain, admin_list_url):
         assert response.data[0]["id"] == str(signature_template.id)
 
         # Test filtering by multiple types
-        response = client.get(admin_list_url, {"type": ["signature", "reply"]})
+        response = client.get(admin_list_url, {"type": ["signature", "message"]})
         assert response.status_code == status.HTTP_200_OK
         assert len(response.data) == 2
         templates_by_type = {t["type"]: t for t in response.data}
         assert "signature" in templates_by_type
-        assert "reply" in templates_by_type
+        assert "message" in templates_by_type
         assert templates_by_type["signature"]["id"] == str(signature_template.id)
-        assert templates_by_type["reply"]["id"] == str(reply_template.id)
+        assert templates_by_type["message"]["id"] == str(message_template.id)
 
         # Test filtering by multiple types with some invalid types (should be ignored)
-        response = client.get(
-            admin_list_url, {"type": ["signature", "invalid_type", "new_message"]}
-        )
+        response = client.get(admin_list_url, {"type": ["signature", "invalid_type"]})
         assert response.status_code == status.HTTP_200_OK
-        assert len(response.data) == 2
+        assert len(response.data) == 1
         templates_by_type = {t["type"]: t for t in response.data}
         assert "signature" in templates_by_type
-        assert "new_message" in templates_by_type
-        assert templates_by_type["signature"]["id"] == str(signature_template.id)
-        assert templates_by_type["new_message"]["id"] == str(new_message_template.id)
-
-        # Test filtering by all valid types
-        response = client.get(
-            admin_list_url, {"type": ["signature", "reply", "new_message"]}
-        )
-        assert response.status_code == status.HTTP_200_OK
-        assert len(response.data) == 3
-        templates_by_type = {t["type"]: t for t in response.data}
         assert templates_by_type["signature"]["id"] == str(signature_template.id)
-        assert templates_by_type["reply"]["id"] == str(reply_template.id)
-        assert templates_by_type["new_message"]["id"] == str(new_message_template.id)
 
 
 class TestAdminMailDomainMessageTemplateCreate:
@@ -164,7 +141,7 @@ def test_unauthorized(self, admin_list_url):
 
         data = {
             "name": "Test Template",
-            "type": "reply",
+            "type": "message",
             "html_body": "<p>Hello {recipient_name}</p>",
             "text_body": "Hello {recipient_name}",
             "raw_body": RAW_DATA,
@@ -189,7 +166,7 @@ def test_forbidden(self, user, admin_list_url):
             "html_body": "<p>Hello {recipient_name}</p>",
             "text_body": "Hello {recipient_name}",
             "raw_body": RAW_DATA,
-            "type": "reply",
+            "type": "message",
             "is_active": True,
             "is_forced": False,
         }
@@ -519,7 +496,7 @@ def test_cannot_change_maildomain(self, user, maildomain, admin_detail_url):
             name="Original Template",
             html_body="<p>Original content</p>",
             text_body="Original content",
-            type=enums.MessageTemplateTypeChoices.REPLY,
+            type=enums.MessageTemplateTypeChoices.MESSAGE,
             maildomain=maildomain,
             raw_body=RAW_DATA_STRUCT,
         )
@@ -532,7 +509,7 @@ def test_cannot_change_maildomain(self, user, maildomain, admin_detail_url):
             "html_body": "<p>Updated content</p>",
             "text_body": "Updated content",
             "raw_body": RAW_DATA,
-            "type": "reply",
+            "type": "message",
             "is_active": False,
             "is_forced": False,
             "maildomain": str(other_maildomain.id),
@@ -604,11 +581,11 @@ def test_partial_update(self, user, maildomain, admin_detail_url):
         )
 
         # Create a template with valid content
-        reply_template = factories.MessageTemplateFactory(
+        message_template = factories.MessageTemplateFactory(
             name="Original Template",
             html_body="<p>Original content</p>",
             text_body="Original content",
-            type=enums.MessageTemplateTypeChoices.REPLY,
+            type=enums.MessageTemplateTypeChoices.MESSAGE,
             maildomain=maildomain,
             raw_body=RAW_DATA_STRUCT,
         )
@@ -620,18 +597,18 @@ def test_partial_update(self, user, maildomain, admin_detail_url):
             "name": "Partially Updated Template",
         }
 
-        response = client.patch(admin_detail_url(reply_template.id), data)
+        response = client.patch(admin_detail_url(message_template.id), data)
         assert response.status_code == status.HTTP_200_OK
         # only name should have been updated
         assert response.data["name"] == "Partially Updated Template"
-        assert response.data["type"] == "reply"
+        assert response.data["type"] == "message"
         assert response.data["html_body"] == "<p>Original content</p>"
         assert response.data["text_body"] == "Original content"
         assert response.data["is_active"]
 
         # check that the template has been updated
-        reply_template.refresh_from_db()
-        assert reply_template.name == "Partially Updated Template"
+        message_template.refresh_from_db()
+        assert message_template.name == "Partially Updated Template"
 
     def test_content_fields_atomic_validation(self, user, maildomain, admin_detail_url):
         """Test that content fields must be updated together atomically."""

src/backend/core/tests/api/test_draft_message_signature.py

@@ -242,11 +242,11 @@ def test_create_draft_with_non_signature_template(
         self, user, mailbox_sender, mailbox_access
     ):
         """Test creating a draft message with a non-signature template."""
-        reply_template = factories.MessageTemplateFactory(
-            name="Reply Template",
-            html_body="<p>Reply content</p>",
-            text_body="Reply content",
-            type=enums.MessageTemplateTypeChoices.REPLY,
+        message_template = factories.MessageTemplateFactory(
+            name="Message Template",
+            html_body="<p>Message content</p>",
+            text_body="Message content",
+            type=enums.MessageTemplateTypeChoices.MESSAGE,
             mailbox=mailbox_sender,
             is_active=True,
         )
@@ -260,7 +260,7 @@ def test_create_draft_with_non_signature_template(
                 "senderId": str(mailbox_sender.id),
                 "subject": "Test Message",
                 "draftBody": "Test body",
-                "signatureId": str(reply_template.id),
+                "signatureId": str(message_template.id),
             },
         )