https://github.com/jwodder/outgoing

Common interface for multiple e-mail methods
https://github.com/jwodder/outgoing

available-on-pypi e-mail email mailbox mbox python send-mail sendmail smtp

Last synced: 1 day ago
JSON representation

Common interface for multiple e-mail methods

• Host: GitHub
• URL: https://github.com/jwodder/outgoing
• Owner: jwodder
• License: mit
• Created: 2021-02-25T22:49:00.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2025-03-31T20:17:06.000Z (3 months ago)
• Last Synced: 2025-06-16T13:05:32.713Z (11 days ago)
• Topics: available-on-pypi, e-mail, email, mailbox, mbox, python, send-mail, sendmail, smtp
• Language: Python
• Homepage:
• Size: 230 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
|repostatus| |ci-status| |coverage| |pyversions| |license|

.. |repostatus| image:: https://www.repostatus.org/badges/latest/active.svg

    :target: https://www.repostatus.org/#active

    :alt: Project Status: Active — The project has reached a stable, usable

          state and is being actively developed.

.. |ci-status| image:: https://github.com/jwodder/outgoing/actions/workflows/test.yml/badge.svg

    :target: https://github.com/jwodder/outgoing/actions/workflows/test.yml

    :alt: CI Status

.. |coverage| image:: https://codecov.io/gh/jwodder/outgoing/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/jwodder/outgoing

.. |pyversions| image:: https://img.shields.io/pypi/pyversions/outgoing.svg

    :target: https://pypi.org/project/outgoing/

.. |license| image:: https://img.shields.io/github/license/jwodder/outgoing.svg

    :target: https://opensource.org/licenses/MIT

    :alt: MIT License

`GitHub `_

| `PyPI `_

| `Documentation `_

| `Issues `_

| `Changelog `_

``outgoing`` provides a common interface to multiple different e-mail sending

methods (SMTP, sendmail, mbox, etc.).  Just construct a sender from a

configuration file or object, pass it an ``EmailMessage`` instance, and let the

magical internet daemons take care of the rest.

``outgoing`` itself provides support for only basic sending methods; additional

methods are provided by extension packages.

See `the documentation `_ for more

information.

Installation

============

``outgoing`` requires Python 3.8 or higher.  Just use `pip

`_ for Python 3 (You have pip, right?) to install

``outgoing`` and its dependencies::

    python3 -m pip install outgoing

Examples

========

A sample configuration file:

.. code:: toml

    [outgoing]

    method = "smtp"

    host = "mx.example.com"

    ssl = "starttls"

    username = "myname"

    password = { file = "~/secrets/smtp-password" }

Sending an e-mail based on a configuration file:

.. code:: python

    from email.message import EmailMessage

    import outgoing

    # Construct an EmailMessage object the standard Python way:

    msg = EmailMessage()

    msg["Subject"] = "Meet me"

    msg["To"] = "[email protected]"

    msg["From"] = "[email protected]"

    msg.set_content(

        "Oh my beloved!\n"

        "\n"

        "Wilt thou dine with me on the morrow?\n"

        "\n"

        "We're having hot pockets.\n"

        "\n"

        "Love, Me\n"

    )

    # Construct a sender object based on the default config file (assuming it's

    # populated)

    with outgoing.from_config_file() as sender:

        # Now send that letter!

        sender.send(msg)

As an alternative to using a configuration file, you can specify an explicit

configuration by passing the configuration structure to the

``outgoing.from_dict()`` method, like so:

.. code:: python

    from email.message import EmailMessage

    import outgoing

    # Construct an EmailMessage object using the eletter library

    # :

    from eletter import compose

    msg1 = compose(

        subject="No.",

        to=["[email protected]"],

        from_="[email protected]",

        text=(

            "Hot pockets?  Thou disgusteth me.\n"

            "\n"

            "Pineapple pizza or RIOT.\n"

        ),

    )

    msg2 = compose(

        subject="I'd like to place an order.",

        to=["[email protected]"],

        from_="[email protected]",

        text="I need the usual.  Twelve Hawaiian Abominations to go, please.\n",

    )

    SENDING_CONFIG = {

        "method": "smtp",

        "host": "smtp.love.love",

        "username": "my.beloved",

        "password": {"env": "SMTP_PASSWORD"},

        "ssl": "starttls",

    }

    with outgoing.from_dict(SENDING_CONFIG) as sender:

        sender.send(msg1)

        sender.send(msg2)