magpie.cli.send_email
=====================

.. py:module:: magpie.cli.send_email

.. autoapi-nested-parse::

   Sends email notification using SMTP connection defined from configuration.

   Useful for validation of SMTP settings retrieved from an INI file or debugging the rendered email contents.



Attributes
----------

.. autoapisummary::

   magpie.cli.send_email.UserConfig
   magpie.cli.send_email.LOGGER


Classes
-------

.. autoapisummary::

   magpie.cli.send_email.EmailTemplateChoiceFormatter


Functions
---------

.. autoapisummary::

   magpie.cli.send_email.make_parser
   magpie.cli.send_email.main


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

.. py:data:: UserConfig

.. py:data:: LOGGER

.. py:class:: EmailTemplateChoiceFormatter(prog, indent_increment=2, max_help_position=24, width=None)

   Bases: :py:obj:`argparse.HelpFormatter`


   Formatter for generating usage messages and argument help strings.

   Only the name of this class is considered a public API. All the methods
   provided by the class are considered an implementation detail.


   .. py:method:: _format_action(action)

      Override the returned help message with available options and shortcuts for email template selection.



.. py:function:: make_parser() -> argparse.ArgumentParser

.. py:function:: main(args: Optional[Sequence[magpie.typedefs.Str]] = None, parser: Optional[argparse.ArgumentParser] = None, namespace: Optional[argparse.Namespace] = None) -> Any