Merge pull request #75 from unicef/feature/240865-setup-mailjet

AB#240865: Setup Mailjet

Author: sergey-misuk-valor

pyproject.toml

@@ -51,6 +51,7 @@ dependencies = [
     "social-auth-app-django",
     "unicef-security>=1.5.1",
     "django-pghistory>=3.5.4",
+    "django-anymail[mailjet]>=13.0",
 ]
 [project.scripts]
 celery-monitor = "country_workspace.__monitor__:run"

src/country_workspace/config/__init__.py

@@ -107,27 +107,6 @@ class Group(Enum):
         "https://django-environ.readthedocs.io/en/latest/types.html#environ-env-db-url",
     ),
     "DEBUG": (bool, False, True, False, setting("debug")),
-    "EMAIL_HOST": (str, "", "", False, setting("email-host")),
-    "EMAIL_HOST_USER": (str, "", "", False, setting("email-host-user")),
-    "EMAIL_HOST_PASSWORD": (str, "", "", False, setting("email-host-password")),
-    "EMAIL_PORT": (int, "25", "25", False, setting("email-port")),
-    "EMAIL_SUBJECT_PREFIX": (
-        str,
-        "[Hope-cw]",
-        "[Hope-ce]",
-        False,
-        setting("email-subject-prefix"),
-    ),
-    "EMAIL_USE_LOCALTIME": (
-        bool,
-        False,
-        False,
-        False,
-        setting("email-use-localtime"),
-    ),
-    "EMAIL_USE_TLS": (bool, False, False, False, setting("email-use-tls")),
-    "EMAIL_USE_SSL": (bool, False, False, False, setting("email-use-ssl")),
-    "EMAIL_TIMEOUT": (str, None, None, False, setting("email-timeout")),
     "ENVIRONMENT": (str, "production", "develop", False, "Environment"),
     "EXTRA_APPS": (list, "", "", False, ""),  # nosec
     "EXTRA_AUTHENTICATION_BACKENDS": (
@@ -189,6 +168,13 @@ class Group(Enum):
     "KOBO_MASTER_API_TOKEN": (str, "", "", False, "Kobo API master token"),
     "KOBO_PROJECT_VIEW_ID": (str, "", "", False, "Kobo project view ID"),
     "KOBO_API_TOKEN": (str, "", "", False, "Kobo API token"),
+    "MAILJET_API_URL": (str, "", "", False, "Mailjet API URL"),
+    "MAILJET_API_KEY": (str, "", "", False, "Mailjet API key"),
+    "MAILJET_SECRET_KEY": (str, "", "", False, "Mailjet API secret key"),
+    "IGNORE_RECIPIENT_STATUS": (bool, False, True),
+    "IGNORE_UNSUPPORTED_FEATURES": (bool, False, True),
+    "REQUESTS_TIMEOUT": (int, 30, 30),
+    "DEBUG_API_REQUESTS": (bool, False, False),
 }
 
 env = SmartEnv(**CONFIG)

src/country_workspace/config/fragments/constance.py

@@ -1,5 +1,6 @@
 from .app import AURORA_API_TOKEN, AURORA_API_URL, HOPE_API_TOKEN, HOPE_API_URL, NEW_USER_DEFAULT_GROUP
 from .kobo import KOBO_API_TOKEN, KOBO_KF_URL, KOBO_MASTER_API_TOKEN, KOBO_PROJECT_VIEW_ID
+from .mail import MAILJET_API_KEY, MAILJET_SECRET_KEY
 
 CONSTANCE_BACKEND = "constance.backends.database.DatabaseBackend"
 
@@ -61,6 +62,8 @@
         " overwrites of newer information.",
         bool,
     ),
+    "MAILJET_API_KEY": (MAILJET_API_KEY, "Mailjet API key", str),
+    "MAILJET_SECRET_KEY": (MAILJET_SECRET_KEY, "Mailjet secret key", "write_only_input"),
 }
 
 CONSTANCE_CONFIG_FIELDSETS = {
@@ -76,6 +79,8 @@
         "KOBO_PROJECT_VIEW_ID",
         "KOBO_KF_URL",
         "KOBO_CACHE_TTL",
+        "MAILJET_API_KEY",
+        "MAILJET_SECRET_KEY",
     ),
     "Data consistency": ("CONCURRENCY_GUARD",),
 }
@@ -86,4 +91,5 @@
     "HOPE_API_TOKEN": "***",
     "KOBO_API_TOKEN": "***",
     "KOBO_API_MASTER_TOKEN": "***",
+    "MAILJET_SECRET_KEY": "***",
 }

src/country_workspace/config/fragments/mail.py

@@ -0,0 +1,15 @@
+from .. import env
+
+DEFAULT_FROM_EMAIL = "hope@unicef.org"
+SERVER_EMAIL = "root@localhost"
+EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
+
+ANYMAIL = {
+    "MAILJET_API_URL": env("MAILJET_API_URL", default="https://api.mailjet.com/v3.1/"),
+    "MAILJET_API_KEY": (MAILJET_API_KEY := env("MAILJET_API_KEY")),
+    "MAILJET_SECRET_KEY": (MAILJET_SECRET_KEY := env("MAILJET_SECRET_KEY")),
+    "IGNORE_RECIPIENT_STATUS": env("IGNORE_RECIPIENT_STATUS", default=True),
+    "IGNORE_UNSUPPORTED_FEATURES": env("IGNORE_UNSUPPORTED_FEATURES", default=True),
+    "REQUESTS_TIMEOUT": env("REQUESTS_TIMEOUT", default=30),
+    "DEBUG_API_REQUESTS": env("DEBUG_API_REQUESTS", default=False),
+}

src/country_workspace/config/settings.py

@@ -48,6 +48,7 @@
     "hope_smart_import",
     "hope_smart_export",
     "smart_env",
+    "anymail",
     "country_workspace.security",
     "country_workspace.apps.HCWConfig",
     "country_workspace.workspaces.apps.Config",
@@ -221,15 +222,6 @@
 AUTH_USER_MODEL = "country_workspace.User"
 SUPERUSERS = env("SUPERUSERS")
 
-DEFAULT_FROM_EMAIL = "hope@unicef.org"
-EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
-EMAIL_HOST = env("EMAIL_HOST", default="")
-EMAIL_HOST_USER = env("EMAIL_HOST_USER", default="")
-EMAIL_HOST_PASSWORD = env("EMAIL_HOST_PASSWORD", default="")
-EMAIL_PORT = env("EMAIL_PORT", default=25)
-EMAIL_USE_TLS = env("EMAIL_USE_TLS", default=False)
-EMAIL_USE_SSL = env("EMAIL_USE_SSL", default=False)
-
 from .fragments.app import *  # noqa: E402, F403
 from .fragments.celery import *  # noqa: E402, F403
 from .fragments.constance import *  # noqa: E402, F403
@@ -244,3 +236,4 @@
 from .fragments.social_auth import *  # noqa: E402, F403
 from .fragments.spectacular import *  # noqa: E402, F403
 from .fragments.tailwind import *  # noqa: E402, F403
+from .fragments.mail import *  # noqa: E402, F403

tests/test_mail_configuration.py

@@ -0,0 +1,26 @@
+from django.core import mail
+from django.core.mail import send_mail
+import pytest
+from pytest_django.fixtures import SettingsWrapper
+
+
+@pytest.fixture
+def mail_backend(settings: SettingsWrapper) -> None:
+    settings.EMAIL_BACKEND = "anymail.backends.test.EmailBackend"
+
+
+def test_mail_configuration(mail_backend: None, settings: SettingsWrapper) -> None:
+    send_mail(subject := "subject", body := "body", from_ := "to@example.com", to := ["user@example.com"])
+
+    assert len(mail.outbox) == 1
+
+    mail0 = mail.outbox[0]
+    assert mail0.subject == subject
+    assert mail0.body == body
+    assert mail0.from_email == from_
+    assert mail0.to == to
+
+    connection = mail0.connection
+    assert connection.debug_api_requests == settings.ANYMAIL["DEBUG_API_REQUESTS"]
+    assert connection.ignore_recipient_status == settings.ANYMAIL["IGNORE_RECIPIENT_STATUS"]
+    assert connection.ignore_unsupported_features == settings.ANYMAIL["IGNORE_UNSUPPORTED_FEATURES"]