Loop through all multiple value fields when sending form submission by email.

A form field with multiple checkboxes may introduce submissions that have more than one value. The `send_email` function would loop through all form fields and grab only the first item of each field, ignoring fields that may have multiple values selected. This is a side effect of using `QueryDict.get()`, which will only return the last value of a list.

This commit fixes that by first converting the `QueryDict` instance to a regular dict of lists so that `get` will return all values, then joining multiple items if needed.

CHANGELOG.txt

@@ -19,6 +19,7 @@ Changelog
  * Fix: ModelAdmin views now consistently call `get_context_data` (Andy Babic)
  * Fix: Header for search results on the redirects index page now shows the correct count when the listing is paginated (Nick Smith)
  * Fix: `set_url_paths` management command is now compatible with Django 1.10 (Benjamin Bach)
+ * Fix: Form builder email notifications now output multiple values correctly (Sævar Öfjörð Magnússon)
 
 
 1.7 (20.10.2016)

docs/releases/1.8.rst

@@ -41,6 +41,7 @@ Bug fixes
  * ModelAdmin views now consistently call ``get_context_data`` (Andy Babic)
  * Header for search results on the redirects index page now shows the correct count when the listing is paginated (Nick Smith)
  * ``set_url_paths`` management command is now compatible with Django 1.10 (Benjamin Bach)
+ * Form builder email notifications now output multiple values correctly (Sævar Öfjörð Magnússon)
 
 Upgrade considerations
 ======================

wagtail/wagtailforms/models.py

@@ -295,7 +295,13 @@ class AbstractEmailForm(AbstractForm):
 
     def send_mail(self, form):
         addresses = [x.strip() for x in self.to_address.split(',')]
-        content = '\n'.join([x[1].label + ': ' + text_type(form.data.get(x[0])) for x in form.fields.items()])
+        content = []
+        for field in form:
+            value = field.value()
+            if isinstance(value, list):
+                value = ', '.join(value)
+            content.append('{}: {}'.format(field.label, value))
+        content = '\n'.join(content)
         send_mail(self.subject, content, addresses, self.from_address,)
 
     class Meta:

wagtail/wagtailforms/tests/test_models.py

@@ -104,6 +104,13 @@ class TestFormSubmission(TestCase):
         self.assertIn("bar", submission[0].form_data)
         self.assertIn("baz", submission[0].form_data)
 
+        # Check that the all the multiple checkbox values are serialised in the
+        # email correctly
+        self.assertEqual(len(mail.outbox), 1)
+        self.assertIn("bar", mail.outbox[0].body)
+        self.assertIn("foo", mail.outbox[0].body)
+        self.assertIn("baz", mail.outbox[0].body)
+
     def test_post_blank_checkbox(self):
         response = self.client.post('/contact-us/', {
             'your-email': 'bob@example.com',
@@ -118,7 +125,7 @@ class TestFormSubmission(TestCase):
 
         # Check that the checkbox was serialised in the email correctly
         self.assertEqual(len(mail.outbox), 1)
-        self.assertIn("Your choices: None", mail.outbox[0].body)
+        self.assertIn("Your choices: ", mail.outbox[0].body)
 
 
 class TestFormWithCustomSubmission(TestCase, WagtailTestUtils):