use html for project invitation email message

onadata/libs/templates/projects/invitation_message.html

@@ -0,0 +1,8 @@
+{% load i18n %}{% blocktranslate %}
+<p>Hello,</p>
+<p>You have been added to {{project_name}} by a project admin allowing you to begin data collection.</p>
+<p>To begin using {{deployment_name}}, please create an account first by clicking the link below:</p>
+<p>{{invitation_url}}</p>
+<p>Thanks,</p>
+<p>The Team at {{ deployment_name }}</p>
+{% endblocktranslate %}

onadata/libs/tests/utils/test_email.py

@@ -155,6 +155,7 @@ def test_email_data_does_not_contain_newline_chars(self):
         self.assertNotIn("\n", email_data.get("subject"))
 
 
+@override_settings(DEFAULT_FROM_EMAIL="[email protected]")
 class ProjectInvitationEmailTestCase(TestBase):
     """Tests for class ProjectInvitationEmail"""
 
@@ -179,21 +180,34 @@ def setUp(self) -> None:
         )
 
     @override_settings(DEPLOYMENT_NAME="Misfit")
-    @patch("onadata.libs.utils.email.send_generic_email")
+    @patch("onadata.libs.utils.email.send_mail")
     def test_send(self, mock_send):
         """Email is sent successfully"""
         self.email.send()
-        email_data = {
-            "subject": "Invitation to Join a Project on Misfit",
-            "message_txt": "\nHello,\n\nYou have been added to Test Invitation by"
-            " a project admin allowing you to begin data collection.\n\nTo begin"
-            " using Misfit, please create an account first by clicking the link below:"
-            "\nhttps://example.com/register"
-            "\n\nThanks,\nThe Team at Misfit\n",
-        }
+        expected_subject = "Invitation to Join a Project on Misfit"
+        expected_message = (
+            "\nHello,\n"
+            "You have been added to Test Invitation by a project admin allowing"
+            " you to begin data collection.\n"
+            "To begin using Misfit, please create an account first by"
+            " clicking the link below:\n"
+            "https://example.com/register\n"
+            "Thanks,\nThe Team at Misfit\n"
+        )
+        expected_html_message = (
+            "\n<p>Hello,</p>\n<p>You have been added to Test Invitation by a project"
+            " admin allowing you to begin data collection.</p>\n"
+            "<p>To begin using Misfit, please create an account first by"
+            " clicking the link below:</p>\n"
+            "<p>https://example.com/register</p>\n"
+            "<p>Thanks,</p>\n<p>The Team at Misfit</p>\n"
+        )
         mock_send.assert_called_with(
-            self.invitation.email,
-            **email_data,
+            expected_subject,
+            expected_message,
+            "[email protected]",
+            (self.invitation.email,),
+            html_message=expected_html_message,
         )
 
     @override_settings(DEPLOYMENT_NAME="Misfit")
@@ -217,38 +231,50 @@ def test_get_template_data(self):
         DEPLOYMENT_NAME="Misfit",
         PROJECT_INVITATION_SUBJECT="Invitation to join {deployment_name}",
         PROJECT_INVITATION_MESSAGE=(
-            "Hello {username}\n\n"
-            "You have been added to {project_name} in the"
-            " {organization} account on Misfit.\n\n"
-            "To begin using Misfit, please verify your account"
-            " first by clicking the link below:\n\n"
-            "{invitation_url}\n\n"
-            "Then, enter you first and last name, desired username,"
+            "<p>Hello {username}</p>"
+            "<p>You have been added to {project_name} in the"
+            " {organization} account on Misfit.</p>"
+            "<p>To begin using Misfit, please verify your account"
+            " first by clicking the link below:</p>"
+            "<p>{invitation_url}</p>"
+            "<p>Then, enter you first and last name, desired username,"
             " and password and click Join. Once complete, please notify"
-            " your project admin {invited_by} and we'll activate your account.\n\n"
+            " your project admin {invited_by} and we'll activate your account.</p>"
         ),
     )
-    @patch("onadata.libs.utils.email.send_generic_email")
+    @patch("onadata.libs.utils.email.send_mail")
     def test_send_custom_message(self, mock_send):
         """Custom subject and message works"""
         self.email.send()
-        email_data = {
-            "subject": "Invitation to join Misfit",
-            "message_txt": (
-                "Hello [email protected]\n\n"
-                "You have been added to Test Invitation in the"
-                " Test User account on Misfit.\n\n"
-                "To begin using Misfit, please verify your account"
-                " first by clicking the link below:\n\n"
-                "https://example.com/register\n\n"
-                "Then, enter you first and last name, desired username,"
-                " and password and click Join. Once complete, please notify"
-                " your project admin [email protected] and we'll activate your account.\n\n"
-            ),
-        }
+        expected_subject = "Invitation to join Misfit"
+        expected_message = (
+            "Hello [email protected]"
+            "You have been added to Test Invitation in the"
+            " Test User account on Misfit."
+            "To begin using Misfit, please verify your account"
+            " first by clicking the link below:"
+            "https://example.com/register"
+            "Then, enter you first and last name, desired username,"
+            " and password and click Join. Once complete, please notify"
+            " your project admin [email protected] and we'll activate your account."
+        )
+        expected_html_message = (
+            "<p>Hello [email protected]</p>"
+            "<p>You have been added to Test Invitation in the"
+            " Test User account on Misfit.</p>"
+            "<p>To begin using Misfit, please verify your account"
+            " first by clicking the link below:</p>"
+            "<p>https://example.com/register</p>"
+            "<p>Then, enter you first and last name, desired username,"
+            " and password and click Join. Once complete, please notify"
+            " your project admin [email protected] and we'll activate your account.</p>"
+        )
         mock_send.assert_called_with(
-            self.invitation.email,
-            **email_data,
+            expected_subject,
+            expected_message,
+            "[email protected]",
+            (self.invitation.email,),
+            html_message=expected_html_message,
         )
 
 

onadata/libs/utils/email.py

@@ -3,8 +3,9 @@
 email utility functions.
 """
 from django.conf import settings
-from django.core.mail import EmailMultiAlternatives
+from django.core.mail import EmailMultiAlternatives, send_mail
 from django.http import HttpRequest
+from django.utils.html import strip_tags
 from django.template.loader import render_to_string
 from six.moves.urllib.parse import urlencode
 from rest_framework.reverse import reverse
@@ -158,17 +159,24 @@ def get_email_data(self) -> dict[str, str]:
             message = custom_message.format(**template_data["body"])
 
         else:
-            message_path = "projects/invitation.txt"
+            message_path = "projects/invitation_message.html"
             message = render_to_string(
                 message_path,
                 template_data["body"],
             )
 
-        return {
-            "subject": subject,
-            "message_txt": message,
-        }
+        return (
+            subject,
+            message,
+        )
 
     def send(self) -> None:
         """Send project invitation email"""
-        send_generic_email(self.invitation.email, **self.get_email_data())
+        subject, message = self.get_email_data()
+        send_mail(
+            subject,
+            strip_tags(message),
+            settings.DEFAULT_FROM_EMAIL,
+            (self.invitation.email,),
+            html_message=message,
+        )