.. This page is generated by scripts/generate_dataclass_docs.py.
   Do not edit manually.


Models / Mail
=============

.. automodule:: teksi_hooks.models.mail

Mail
----

.. autoclass:: teksi_hooks.models.mail.Mail
   :members:

Fields
~~~~~~

``recipients``
   Type: ``tuple``

   Recipient email addresses.

``subject``
   Type: ``str``

   Email subject line.

``body``
   Type: ``str``

   Plain text email body.

``cc``
   Type: ``tuple``

   Optional carbon-copy recipient email addresses.

``bcc``
   Type: ``tuple``

   Optional blind carbon-copy recipient email addresses.


SmtpConfiguration
-----------------

.. autoclass:: teksi_hooks.models.mail.SmtpConfiguration
   :members:

Fields
~~~~~~

``host``
   Type: ``str``

   SMTP server hostname.

``port``
   Type: ``int``

   SMTP server port.

``username``
   Type: ``str | None``

   Optional SMTP username.

``password``
   Type: ``str | None``

   Optional SMTP password.

``sender``
   Type: ``str``

   Sender email address.

``use_tls``
   Type: ``bool``

   Whether to establish a TLS-secured SMTP connection.