Merge pull request #245 from RSE-Sheffield/feat/243-mass-email

Send invite email to multiple recipients

Author: Joe-Heffer-Shef

SORT/settings.py

@@ -65,6 +65,8 @@ def cast_to_boolean(obj: Any) -> bool:
     "django_extensions",
     "debug_toolbar",
     "qr_code",
+    "crispy_forms",
+    "crispy_bootstrap5",
     # apps created by FA:
     "home",
     "survey",
@@ -254,3 +256,8 @@ def cast_to_boolean(obj: Any) -> bool:
     "Midwives": "sort_only_config_midwives.json",
     "NMAHPs": "sort_only_config_nmahps.json",
 }
+
+# Crispy enables Bootstrap styling on Django forms
+# https://django-crispy-forms.readthedocs.io/en/latest/install.html
+CRISPY_ALLOWED_TEMPLATE_PACKS = "bootstrap5"
+CRISPY_TEMPLATE_PACK = "bootstrap5"

requirements.txt

@@ -31,3 +31,5 @@ pytest==8.3.4
 pytest-django==4.9.0
 django-qr-code==4.1.0
 factory-boy==3.3.3
+django-crispy-forms==2.4
+crispy-bootstrap5==2025.4

survey/forms.py

@@ -3,13 +3,22 @@
 from django.forms import BaseFormSet, formset_factory
 from strenum import StrEnum
 
+from .validators.email_list_validator import EmailListValidator
+
 
 class InvitationForm(forms.Form):
-    email = forms.EmailField(
-        label="Participant Email",
-        max_length=100,
+    email = forms.CharField(
+        label="Participant Emails",
+        help_text="Please enter a list of email addresses",
         required=True,
-        validators=[EmailValidator()],
+        validators=[EmailListValidator()],
+        widget=forms.Textarea(attrs=dict(rows=6)),
+    )
+    message = forms.CharField(
+        label="Message",
+        help_text="(Optional) Additional message for the participants",
+        required=False,
+        widget=forms.Textarea(attrs=dict(rows=3)),
     )
 
 

survey/templates/invitations/send_invitation.html

@@ -1,38 +1,17 @@
 {% extends 'base_manager.html' %}
-
+{% load crispy_forms_tags %}
 {% block content %}
     <div class="container mx-auto px-4 py-8 mt-4">
         <div>
             <h1>Invitations</h1>
             <p class="subtitle">Use the form below to send out invitations to your survey participants.</p>
         </div>
-
-
         <div class="card custom-card shadow-sm my-4">
             <div class="card-body">
-
                 <form method="post">
                     {% csrf_token %}
-
-                    <div class="mb-3">
-                        <label for="id_email" class="form-label">Email Address</label>
-                        <input type="email" name="email" id="id_email" class="form-control"
-                               placeholder="Enter email address" required>
-                        <small class="form-text text-muted">Enter the participant's email address.</small>
-                    </div>
-
-                    <div class="mb-3">
-                        <label for="id_message" class="form-label">Message (Optional)</label>
-                        <textarea name="message" id="id_message" class="form-control" rows="3"
-                                  placeholder="Write your message here..."></textarea>
-                        <small class="form-text text-muted">Add any additional messages.</small>
-                    </div>
-
-                    <div class="text-center">
-                        <button type="submit" class="btn btn-primary" style="background-color: #6933AD; border: none;">
-                            Send
-                        </button>
-                    </div>
+                    {{ form | crispy }}
+                    <button type="submit" class="btn btn-primary">Send</button>
                 </form>
             </div>
 

survey/urls.py

@@ -98,5 +98,5 @@
         views.SurveyLinkInvalidView.as_view(),
         name="survey_link_invalid",
     ),
-    path("invite/<int:pk>", views.InvitationView.as_view(), name="invite"),
+    path("survey/<int:pk>/invite", views.InvitationView.as_view(), name="invite"),
 ]

survey/validators/__init__.py

@@ -0,0 +1,20 @@
+from django.core.validators import EmailValidator
+
+
+class EmailListValidator(EmailValidator):
+    """
+    Validate a sequence of email addresses.
+    """
+    message = "Enter valid email addresses."
+
+    @classmethod
+    def clean(cls, value):
+        """
+        Separate strings by commas or whitespace.
+        """
+        # Replace commas with whitespace
+        return [email.strip() for email in value.replace(",", " ").lower().split()]
+
+    def __call__(self, value):
+        for email in self.clean(value):
+            super().__call__(email)

survey/validators/email_list_validator.py

@@ -529,7 +529,7 @@ class InvitationView(FormView):
     form_class = InvitationForm
 
     def form_valid(self, form):
-        email = form.cleaned_data["email"]
+        recipient_list = tuple(form.cleaned_data["email"].replace(",", " ").split())
         message = form.data["message"]
         survey = Survey.objects.get(pk=self.kwargs["pk"])
         # Generate the survey link with the token
@@ -541,12 +541,12 @@ def form_valid(self, form):
             subject="Your SORT Survey Invitation",
             message=f"Click here to start the SORT survey:\n{survey_link}\n\n{message}",
             from_email=settings.DEFAULT_FROM_EMAIL,
-            recipient_list=[email],
+            recipient_list=recipient_list,
             fail_silently=False,
         )
 
         # Show success message
-        messages.success(self.request, f"Invitation sent to {email}.")
+        messages.success(self.request, f"Invitation sent to {len(recipient_list)} recipients.")
         return super().form_valid(form)
 
     def get_success_url(self):