Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 1.4 KB

pyapi.rst

File metadata and controls

50 lines (37 loc) · 1.4 KB
Raw
.. currentmodule:: outgoing

Core Python API

Functions

outgoing provides the following functions for constructing e-mail sender objects. Once you have a sender object, simply use it in a context manager to open it up, and then call its send() method with each email.message.EmailMessage object you want to send. See :ref:`examples` for examples.

.. autofunction:: from_config_file

.. autofunction:: from_dict

.. autofunction:: get_default_configpath

Sender Objects

.. autoclass:: Sender()
    :special-members: __enter__, __exit__

In addition to the base protocol, outgoing's built-in senders are reentrant and reusable as context managers, and their send() methods can be called outside of a context.

Exceptions

.. autoexception:: outgoing.errors.Error
    :show-inheritance:

.. autoexception:: outgoing.errors.InvalidConfigError
    :show-inheritance:

.. autoexception:: outgoing.errors.InvalidPasswordError
    :show-inheritance:

.. autoexception:: outgoing.errors.MissingConfigError
    :show-inheritance:

.. autoexception:: outgoing.errors.NetrcLookupError
    :show-inheritance:

.. autoexception:: outgoing.errors.UnsupportedEmailError
    :show-inheritance: