election_day.views.subscription
===============================

.. py:module:: election_day.views.subscription


Functions
---------

.. autoapisummary::

   election_day.views.subscription.subscribe_email
   election_day.views.subscription.optin_email
   election_day.views.subscription.unsubscribe_email
   election_day.views.subscription.optout_email
   election_day.views.subscription.subscribe_sms
   election_day.views.subscription.unsubscribe_sms


Module Contents
---------------

.. py:function:: subscribe_email(self: onegov.election_day.models.Principal, request: onegov.election_day.request.ElectionDayRequest, form: onegov.election_day.forms.EmailSubscriptionForm) -> onegov.core.types.RenderData

   Initiate the email notification subscription. 


.. py:function:: optin_email(self: onegov.election_day.models.Principal, request: onegov.election_day.request.ElectionDayRequest, form: onegov.election_day.forms.EmailSubscriptionForm) -> onegov.core.types.RenderData

   Confirm the email used for the subscription. 


.. py:function:: unsubscribe_email(self: onegov.election_day.models.Principal, request: onegov.election_day.request.ElectionDayRequest, form: onegov.election_day.forms.EmailSubscriptionForm) -> onegov.core.types.RenderData

   Initiates the email notification unsubscription. 


.. py:function:: optout_email(self: onegov.election_day.models.Principal, request: onegov.election_day.request.ElectionDayRequest, form: onegov.election_day.forms.EmailSubscriptionForm) -> onegov.core.types.RenderData | morepath.request.Response

   Deactivates the email subscription.

   Allows one-click unsubscription as defined by RFC-8058:
       curl -X POST http://localhost:8080/xx/zg/unsubscribe-email?opaque=yy



.. py:function:: subscribe_sms(self: onegov.election_day.models.Principal, request: onegov.election_day.request.ElectionDayRequest, form: onegov.election_day.forms.SmsSubscriptionForm) -> onegov.core.types.RenderData

   Adds the given phone number to the SMS subscribers.


.. py:function:: unsubscribe_sms(self: onegov.election_day.models.Principal, request: onegov.election_day.request.ElectionDayRequest, form: onegov.election_day.forms.SmsSubscriptionForm) -> onegov.core.types.RenderData

   Removes the given phone number from the SMS subscribers.