election_day.layouts.mail
=========================

.. py:module:: election_day.layouts.mail


Classes
-------

.. autoapisummary::

   election_day.layouts.mail.MailLayout


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

.. py:class:: MailLayout(model: Any, request: onegov.election_day.request.ElectionDayRequest)

   Bases: :py:obj:`onegov.election_day.layouts.default.DefaultLayout`


   A special layout for creating HTML E-Mails. 


   .. py:property:: base
      :type: chameleon.PageTemplateFile


      Returns the layout, which defines the base layout of all pages.

      See ``templates/layout.pt``.




   .. py:property:: primary_color
      :type: str



   .. py:method:: model_title(model: onegov.election_day.models.Election | onegov.election_day.models.ElectionCompound | onegov.election_day.models.Vote) -> str | None

      Returns the translated title of the given election or vote. Falls
      back to the title of the default fallback, if no translated title is
      available. 



   .. py:method:: model_url(model: object) -> str

      Returns the localized link to the given election of vote. 



   .. py:method:: subject(model: onegov.election_day.models.Election | onegov.election_day.models.ElectionCompound | onegov.election_day.models.Vote) -> str

      Returns a nice subject for the given model. 



   .. py:property:: optout_link
      :type: str


      Returns the opt-out link of the principal.