pipeline.src.flows.email_actions_to_units
=========================================

.. py:module:: pipeline.src.flows.email_actions_to_units


Functions
---------

.. autoapisummary::

   pipeline.src.flows.email_actions_to_units.get_actions_period
   pipeline.src.flows.email_actions_to_units.extract_mission_actions
   pipeline.src.flows.email_actions_to_units.get_control_unit_ids
   pipeline.src.flows.email_actions_to_units.filter_control_units
   pipeline.src.flows.email_actions_to_units.to_control_unit_actions
   pipeline.src.flows.email_actions_to_units.get_template
   pipeline.src.flows.email_actions_to_units.render
   pipeline.src.flows.email_actions_to_units.create_email
   pipeline.src.flows.email_actions_to_units.send_mission_actions_email
   pipeline.src.flows.email_actions_to_units.control_unit_actions_list_to_df
   pipeline.src.flows.email_actions_to_units.load_emails_sent_to_control_units
   pipeline.src.flows.email_actions_to_units.email_actions_to_units_flow


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

.. py:function:: get_actions_period(utcnow: datetime.datetime, start_days_ago: int, end_days_ago: int) -> src.helpers.dates.Period

.. py:function:: extract_mission_actions(period: src.helpers.dates.Period) -> pandas.DataFrame

.. py:function:: get_control_unit_ids(env_action: pandas.DataFrame) -> List[int]

.. py:function:: filter_control_units(all_control_units: List[src.entities.control_units.ControlUnit], control_unit_ids: List[str]) -> List[src.entities.control_units.ControlUnit]

.. py:function:: to_control_unit_actions(mission_actions: pandas.DataFrame, period: src.helpers.dates.Period, control_units: List[src.entities.control_units.ControlUnit]) -> List[src.entities.control_units.ControlUnitActions]

.. py:function:: get_template() -> jinja2.Template

.. py:function:: render(control_unit_actions: src.entities.control_units.ControlUnitActions, template: jinja2.Template) -> str

.. py:function:: create_email(html: str, actions: src.entities.control_units.ControlUnitActions, test_mode: bool) -> email.message.EmailMessage

.. py:function:: send_mission_actions_email(message: email.message.EmailMessage, actions: src.entities.control_units.ControlUnitActions, is_integration: bool) -> List[src.entities.control_units.ControlUnitActionsSentMessage]

   Sends input email using the contents of `From` header as sender and `To`, `Cc`
   and `Bcc` headers as recipients.

   :param message: email message to send
   :type message: EmailMessage
   :param actions: `ControlUnitActions` related to message
   :type actions: ControlUnitActions
   :param is_integration: if ``False``, the message is not actually sent
   :type is_integration: bool

   :returns: List of sent messages and their error
             codes, if any.
   :rtype: List[ControlUnitActionsSentMessage]


.. py:function:: control_unit_actions_list_to_df(messages: List[src.entities.control_units.ControlUnitActionsSentMessage]) -> pandas.DataFrame

.. py:function:: load_emails_sent_to_control_units(emails_sent_to_control_units: pandas.DataFrame)

.. py:function:: email_actions_to_units_flow(test_mode: bool, is_integration: bool, start_days_ago: int, end_days_ago: int, fetch_control_units_fn: Callable = fetch_control_units)