https://github.com/jwodder/eletter

Simple e-mail composition & decomposition
https://github.com/jwodder/eletter

available-on-pypi e-mail email emailmessage message python

Last synced: 20 days ago
JSON representation

Simple e-mail composition & decomposition

• Host: GitHub
• URL: https://github.com/jwodder/eletter
• Owner: jwodder
• License: mit
• Created: 2021-03-09T15:56:02.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-29T23:37:38.000Z (4 months ago)
• Last Synced: 2024-10-06T09:20:42.160Z (about 2 months ago)
• Topics: available-on-pypi, e-mail, email, emailmessage, message, python
• Language: Python
• Homepage:
• Size: 196 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 2
• 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/eletter/actions/workflows/test.yml/badge.svg

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

    :alt: CI Status

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

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

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

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

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

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

    :alt: MIT License

`GitHub `_

| `PyPI `_

| `Documentation `_

| `Issues `_

| `Changelog `_

``eletter`` provides functionality for constructing & deconstructing

``email.message.EmailMessage`` instances without having to touch the needlessly

complicated ``EmailMessage`` class itself.  A simple function enables

composition of e-mails with text and/or HTML bodies plus attachments, and

classes are provided for composing more complex multipart e-mails.

Installation

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

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

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

``eletter`` and its dependencies::

    python3 -m pip install eletter

Examples

========

Constructing an e-mail with the ``compose()`` function:

.. code:: python

    import eletter

    TEXT = (

        "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"

    )

    HTML = (

        "
Oh my beloved!
\n"

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

        "
We're having hot pockets.
\n"

        "
Love, Me
\n"

    )


    with open("hot-pocket.png", "rb") as fp:

        picture = eletter.BytesAttachment(

            content=fp.read(),

            filename="enticement.png",

            content_type="image/png",

        )

    msg = eletter.compose(

        subject="Meet Me",

        from_="[email protected]",

        to=[eletter.Address("My Dear", "[email protected]")],

        text=TEXT,

        html=HTML,

        attachments=[picture],

    )

``msg`` can then be sent like any other ``EmailMessage``, say, by using

outgoing_.

.. _outgoing: https://github.com/jwodder/outgoing

For more complex e-mails, a set of classes is provided.  Here is the equivalent

of the HTML-with-image e-mail with alternative plain text version from the

``email`` `examples page`__ in the Python docs:

__ https://docs.python.org/3/library/email.examples.html

.. code:: python

    from email.utils import make_msgid

    import eletter

    text = eletter.TextBody(

        "Salut!\n"

        "\n"

        "Cela ressemble à un excellent recipie[1] déjeuner.\n"

        "\n"

        "[1] http://www.yummly.com/recipe/Roasted-Asparagus-Epicurious-203718\n"

        "\n"

        "--Pepé\n"

    )

    asparagus_cid = make_msgid()

    html = eletter.HTMLBody(

        "\n"

        "  \n"

        "  \n"

        "    
Salut!
\n"

        "    
Cela ressemble à un excellent\n"

        '        \n'

        "            recipie\n"

        "         déjeuner.\n"

        "    
\n"

        f'    \n'

        "  \n"

        "\n"

    )


    image = eletter.BytesAttachment.from_file(

        "roasted-asparagus.jpg",

        inline=True,

        content_id=asparagus_cid,

    )

    msg = (text | (html ^ image)).compose(

        subject="Ayons asperges pour le déjeuner",

        from_=eletter.Address("Pepé Le Pew", "[email protected]"),

        to=[

            eletter.Address("Penelope Pussycat", "[email protected]"),

            eletter.Address("Fabrette Pussycat", "[email protected]"),

        ],

    )