:py:mod:`event.handler.smtp`
============================

.. py:module:: event.handler.smtp

.. autoapi-nested-parse::

   SMTP event handler.



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

Classes
~~~~~~~

.. autoapisummary::

   event.handler.smtp.SMTPHandler




.. py:class:: SMTPHandler(subject: str, from_addr: str, to_addr: str, smtp_servers: str | list[str])


   Bases: :py:obj:`e3.event.EventHandler`

   Event handler that sends events via email using SMTP.

   .. py:property:: subject
      :type: str

      Subject.


   .. py:method:: decode_config(config_str: str) -> dict[str, str | list[str]]
      :classmethod:

      Decode configuration string.

      :param config_str: configuration string


   .. py:method:: encode_config() -> str

      Encode configuration to string representation.


   .. py:method:: send_event(event: e3.event.Event) -> bool

      Send an event.

      :param event: an event
      :return: True if the event was sent successfully