Feature: Double opt-in

README.rst

@@ -244,8 +244,34 @@ Included in birdsong is a basic way for contacts to unsubscribe, just include th
     </mj-section>
     {% endblock email_body %}
 
+Birdsong settings 
+=================
 
 
+The website's admin can set settings with regard to
+
+- redirects
+- double opt-in 
+
+If a redirect is set, the original template will not be used anymore.
+
+
+.. image:: docs/birdsong-settings.png
+    :width: 900
+    :alt: Screenshot
+
+Double opt in
+=============
+
+For security reasons it is better if a double opt-in is used for subscription. 
+It assures sending the campaign only to people who agreed to it and follows the regulations of EU's GDPR. 
+The double opt-in feature can be enabled in 'Birdsong settings' in the admin menu. 
+The subscribing person will receive an e-mail with a link for confirmation. 
+Unconfirmed contacts older than a week are deleted, when a campaign is saved, so when creating, editing or copying.
+
+
+**!! Warning !!** 
+By enabling this feature without garantueeing that field ``is_confirmed`` is ``True`` of the old contacts, the ones who are older than a week will be deleted when campaign saving is triggered!
 
 Future features:
 ----------------
@@ -255,3 +281,4 @@ Future features:
 - Backends other thans SMTP for sending emails so analytics can be gathered (email opened, bounced etc)
 - Reloading the preview on edit
 - Broader permissions for campaigns (send, preview, test send)
+spot

birdsong/__init__.py

@@ -1 +1 @@
-default_app_config = 'birdsong.apps.WagtailBirdsongApp'
+default_app_config = "birdsong.apps.WagtailBirdsongApp"

birdsong/apps.py

@@ -1,8 +1,16 @@
 from django.apps import AppConfig
+from django.db.models.signals import post_save
+
 
 
 class WagtailBirdsongApp(AppConfig):
     default_auto_field = "django.db.models.BigAutoField"
     name = 'birdsong'
     label = 'birdsong'
     verbose_name = 'Wagtail Birdsong'
+
+    def ready(self):
+        from .signals import clean_unconfirmed_contacts
+        from .models import Campaign
+        for subclass in Campaign.__subclasses__():
+            post_save.connect(clean_unconfirmed_contacts, sender=subclass)

birdsong/backends/smtp.py

@@ -5,6 +5,8 @@
 from django.db import close_old_connections, transaction
 from django.template.loader import render_to_string
 from django.utils import timezone
+from django.utils.html import format_html
+from django.utils.translation import gettext as _
 
 from birdsong.models import Campaign, CampaignStatus, Contact
 from birdsong.utils import send_mass_html_mail
@@ -22,6 +24,7 @@ def __init__(self, campaign_pk, contact_pks, messages):
         self.messages = messages
 
     def run(self):
+
         try:
             logger.info(f"Sending {len(self.messages)} emails")
             send_mass_html_mail(self.messages)
@@ -52,16 +55,34 @@ def send_campaign(self, request, campaign, contacts, test_send=False):
                 campaign.get_context(request, contact),
             )
             messages.append({
-                'subject': campaign.subject,
-                'body': content,
-                'from_email': self.from_email,
-                'to': [contact.email],
-                'reply_to': [self.reply_to],
-            })
+                    "subject": campaign.subject,
+                    "body": content,
+                    "from_email": self.from_email,
+                    "to": [contact.email],
+                    "reply_to": [self.reply_to],
+                })
         if test_send:
             # Don't mark as complete, don't worry about threading
             send_mass_html_mail(messages)
         else:
             campaign_thread = SendCampaignThread(
                 campaign.pk, [c.pk for c in contacts], messages)
             campaign_thread.start()
+
+    def send_confirmation(self, request, contact, url):
+        from birdsong.models import BirdsongSettings
+
+        settings = BirdsongSettings.load(request_or_site=request)
+
+        body = settings.confirmation_email_body + format_html(
+            _('\nClick <a href="{}">here</a>!'), url
+            )
+
+        message = {
+            "subject": settings.confirmation_email_subject,
+            "body": body,
+            "from_email": self.from_email,
+            "to": [contact.email],
+            "reply_to": [self.reply_to],
+        }
+        send_mass_html_mail([message])

birdsong/blocks.py

@@ -1,4 +1,5 @@
 from django.utils.html import mark_safe
+from django.utils.translation import gettext_lazy as _
 from wagtail.core import blocks
 
 
@@ -13,3 +14,27 @@ class DefaultBlocks(UnwrappedStreamBlock):
     rich_text = blocks.RichTextBlock(
         template='birdsong/mail/blocks/richtext.html',
         features=['h3', 'h4', 'bold', 'italic', 'link', 'ul', 'ol', 'document-link'])
+
+
+class NewsletterSubscriptionBlock(blocks.StructBlock):
+    """streamfield block for newsletter subscription on wagtail pages."""
+
+    headline = blocks.CharBlock(verbose_name=_('Headline'), max_length=80)
+    subtext = blocks.CharBlock(
+        verbose_name=_('Subtext'), max_length=150, required=False
+    )
+    button_label = blocks.CharBlock(label=_('Button label'), max_length=50)
+    privacy_text = blocks.RichTextBlock(
+        label=_('Privacy Disclaimer'), max_length=500,
+        features=[
+            'bold',
+            'italic',
+            'link',
+        ]
+    )
+
+
+    class Meta:
+        template = 'birdsong/site/blocks/signup.html'
+        icon = 'mail'
+        label = _('Newsletter subscription')

birdsong/forms.py

@@ -0,0 +1,8 @@
+from django import forms
+from birdsong.models import Contact
+
+
+class ContactForm(forms.ModelForm):
+    class Meta:
+        model = Contact
+        fields = ('email',)