✨(email) white brand email

The email was branded "La Suite Numérique",
we updated the template to make it generic, we
will use settings env variables to customize the
email for each brand.

Author: AntoLC

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to
 ## Added
 
 - ✨(backend) add server-to-server API endpoint to create documents #467
+- ✨(email) white brand email #412
 
 
 ## [1.9.0] - 2024-12-11

env.d/development/common.dist

@@ -16,7 +16,9 @@ PYTHONPATH=/app
 # impress settings
 
 # Mail
+DJANGO_EMAIL_BRAND_NAME="La Suite Numérique"
 DJANGO_EMAIL_HOST="mailcatcher"
+DJANGO_EMAIL_LOGO_IMG="http://localhost:3000/assets/logo-suite-numerique.png"
 DJANGO_EMAIL_PORT=1025
 
 # Backend url

src/backend/core/models.py

@@ -552,9 +552,11 @@ def send_email(self, subject, emails, context=None, language=None):
         language = language or get_language()
         context.update(
             {
+                "brandname": settings.EMAIL_BRAND_NAME,
+                "document": self,
                 "domain": domain,
                 "link": f"{domain}/docs/{self.id}/",
-                "document": self,
+                "logo_img": settings.EMAIL_LOGO_IMG,
             }
         )
 

src/backend/core/tests/documents/test_api_document_invitations.py

@@ -7,6 +7,7 @@
 from unittest import mock
 
 from django.core import mail
+from django.test import override_settings
 from django.utils import timezone
 
 import pytest
@@ -339,6 +340,7 @@ def test_api_document_invitations_create_authenticated_outsider():
     assert response.status_code == 403
 
 
+@override_settings(EMAIL_BRAND_NAME="My brand name", EMAIL_LOGO_IMG="my-img.jpg")
 @pytest.mark.parametrize(
     "inviting,invited,response_code",
     (
@@ -407,6 +409,8 @@ def test_api_document_invitations_create_privileged_members(
             f"{user.full_name} ({user.email}) invited you with the role ``{invited}`` "
             f"on the following document: {document.title}"
         ) in email_content
+        assert "My brand name" in email_content
+        assert "my-img.jpg" in email_content
     else:
         assert models.Invitation.objects.exists() is False
 
@@ -453,7 +457,7 @@ def test_api_document_invitations_create_email_from_content_language():
     assert email.to == ["[email protected]"]
 
     email_content = " ".join(email.body.split())
-    assert f"{user.full_name} a partagé un document avec vous !" in email_content
+    assert f"{user.full_name} a partagé un document avec vous!" in email_content
 
 
 def test_api_document_invitations_create_email_from_content_language_not_supported():

src/backend/impress/settings.py

@@ -352,9 +352,11 @@ class Base(Configuration):
 
     # Mail
     EMAIL_BACKEND = values.Value("django.core.mail.backends.smtp.EmailBackend")
+    EMAIL_BRAND_NAME = values.Value(None)
     EMAIL_HOST = values.Value(None)
     EMAIL_HOST_USER = values.Value(None)
     EMAIL_HOST_PASSWORD = values.Value(None)
+    EMAIL_LOGO_IMG = values.Value(None)
     EMAIL_PORT = values.PositiveIntegerValue(None)
     EMAIL_USE_TLS = values.BooleanValue(False)
     EMAIL_USE_SSL = values.BooleanValue(False)