Nessuna descrizione

Mikael Koli 685ee44452 Merge pull request #9 from Miksus/docs/reformat 4 anni fa
.github 8419cc7c5d Update issue templates 4 anni fa
docs c649b3db80 docs: updated the look of the docs 4 anni fa
redmail cb4ca42f8b test: fix pandas Excel attachment test 4 anni fa
requirements f65b152c59 requirements: add openpyxl to soft dependencies 4 anni fa
.coveragerc 693e185ff1 pkg: add codecov 4 anni fa
.gitattributes 4d0402d493 pkg: add packaging and setup files 4 anni fa
.gitignore 4d0402d493 pkg: add packaging and setup files 4 anni fa
LICENSE ea339454e4 Create LICENSE 4 anni fa
MANIFEST.in 4e69b9cc6a pkg: added text templates and test files 4 anni fa
README.md c649b3db80 docs: updated the look of the docs 4 anni fa
requirements.txt f65b152c59 requirements: add openpyxl to soft dependencies 4 anni fa
setup.cfg 4d0402d493 pkg: add packaging and setup files 4 anni fa
setup.py 89792f820b pkg: updated PyPI classifiers 4 anni fa
tox.ini d28a6f5f6f ci: fix tox 4 anni fa
versioneer.py 2966ecd133 pkg: Some weird issues in versioneer 4 anni fa

README.md

Red Mail: Advanced Email Sender

Next generation email sender


Pypi version build codecov Documentation Status PyPI pyversions

What is it?

Red Mail is an advanced email sender library. It makes sending emails trivial and has a lot of advanced features such as:

See more from the documentations or see release from PyPI.

Install it from PyPI:

pip install redmail

Why Red Mail?

Sending emails SHOULD NOT be this complicated:

import smtplib
from email.mime.multipart import MIMEMultipart
from email.mime.text import MIMEText

msg = MIMEMultipart('alternative')
msg['Subject'] = 'An example email'
msg['From'] = 'first.last@gmail.com'
msg['To'] = 'first.last@example.com'

part1 = MIMEText("Hello!", 'plain')
part2 = MIMEText("<h1>Hello!</h1>", 'html')

msg.attach(part1)
msg.attach(part2)

# Send the message via our own SMTP server.
s = smtplib.SMTP('localhost', port=0)
s.send_message(msg)
s.quit()

With Red Mail, it is simple as this:

from redmail import EmailSender

email = EmailSender(host="localhost", port=0)

email.send(
    subject="An example email",
    sender="me@example.com",
    receivers=['first.last@example.com'],
    text="Hello!",
    html="<h1>Hello!</h1>"
)

You can also do more advanced things easily with it:

from redmail import EmailSender

email = EmailSender(
    host="localhost", port=0,
    user_name="me@example.com", password="<PASSWORD>"
)

email.send(
    subject="An example email",
    sender="me@example.com",

    # Recipients
    receivers=['first.last@example.com'],
    cc=["also@example.com"],
    bcc=["external@example.com"],

    # Body of the email
    html="""<h1>Hello {{ friend }}!</h1>
        <p>Have you seen this thing:</p>
        {{ awesome_image }}
        <p>Or this:</p>
        {{ pretty_table }}
        <p>Or this plot:</p>
        {{ a_plot }}
        <p>Kind regards, {{ sender.full_name }}</p>
    """,

    # Content that is embed to the body
    body_params={'friend': 'Jack'},
    body_images={
        'awesome_image': 'path/to/image.png',
        'a_plot': plt.Figure(...)
    },
    body_tables={
        'pretty_table': pd.DataFrame(...)
    },

    # Attachments of the email
    attachments={
        'some_data.csv': pd.DataFrame(...),
        'file_content.html': '<h1>This is an attachment</h1>',
        'a_file.txt': pathlib.Path('path/to/file.txt')
    }
)

Short examples from here.

Practical example in cookbook.


Author

  • Mikael Koli - Miksus - koli.mikael@gmail.com