magpie.cli.send_email

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

UserConfig
LOGGER

Classes

EmailTemplateChoiceFormatter

Formatter for generating usage messages and argument help strings.

Functions

make_parser(→ argparse.ArgumentParser)
main(→ Any)

Module Contents

magpie.cli.send_email.UserConfig

magpie.cli.send_email.LOGGER

class magpie.cli.send_email.EmailTemplateChoiceFormatter(prog, indent_increment=2, max_help_position=24, width=None)

Bases: 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.

_format_action(action)

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

magpie.cli.send_email.make_parser() → argparse.ArgumentParser

magpie.cli.send_email.main(args: Sequence[magpie.typedefs.Str] | None = None, parser: argparse.ArgumentParser | None = None, namespace: argparse.Namespace | None = None) → Any