org.mail
========

.. py:module:: org.mail


Classes
-------

.. autoapisummary::

   org.mail.TicketEmailExtraArguments


Functions
---------

.. autoapisummary::

   org.mail.send_html_mail
   org.mail.send_transactional_html_mail
   org.mail.send_marketing_html_mail
   org.mail.send_ticket_mail


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

.. py:class:: TicketEmailExtraArguments

   Bases: :py:obj:`TypedDict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: reply_to
      :type:  email.headerregistry.Address | str | None


   .. py:attribute:: cc
      :type:  onegov.core.types.SequenceOrScalar[email.headerregistry.Address | str]


   .. py:attribute:: headers
      :type:  dict[str, str] | None


.. py:function:: send_html_mail(request: onegov.org.request.OrgRequest, template: str, content: dict[str, Any], **kwargs: typing_extensions.Unpack[EmailArgumentsWithCategory]) -> None

   " Sends an email rendered from the given template.

   Example::

       send_html_mail(request, 'mail_template.pt', {'model': self},
           subject=_("Test subject")
           receivers=('recipient@example.org', )
       )



.. py:function:: send_transactional_html_mail(request: onegov.org.request.OrgRequest, template: str, content: dict[str, Any], **kwargs: typing_extensions.Unpack[EmailArguments]) -> None

.. py:function:: send_marketing_html_mail(request: onegov.org.request.OrgRequest, template: str, content: dict[str, Any], **kwargs: typing_extensions.Unpack[EmailArguments]) -> None

.. py:function:: send_ticket_mail(request: onegov.org.request.OrgRequest, template: str, subject: str, receivers: collections.abc.Sequence[email.headerregistry.Address | str], ticket: onegov.ticket.Ticket, content: dict[str, Any] | None = None, force: bool = False, send_self: bool = False, bcc: onegov.core.types.SequenceOrScalar[email.headerregistry.Address | str] = (), attachments: collections.abc.Iterable[onegov.core.mail.Attachment | _typeshed.StrPath] = (), **kwargs: typing_extensions.Unpack[TicketEmailExtraArguments]) -> None