postale 1.3.4

Simple wrapper around `smtplib` and `email` libraries.

Postale

Postale is a simple module that wraps smtplib and email libraries. It is configured in order to make it easy to create a new mail, and setup attachments, body, etc.

Installation

pip install postale

Usage

Import it

You can either

import postale

or

from postale import Mail, Gmail

Mail is the most generic class in the module, Gmail inherits everything from it, but has specific arguments already set for the gmail client.

Note: The gmail SMTP provider needs you to set an App Password, different from your e-mail password.

Create an e-mail

To create a mail, use de Mail constructor:

my_mail = Mail(
    'smtp.host.com',
    port = 25,
    # other kwargs...
)

# With Gmail class you don't need to specify the host nor the port:
my_gmail = Mail(
    # kwargs...
)

You can specify all the e-mail properties, right in the constructor too:

my_mail = Mail(
    host = 'smtp.host.com',
    sender = '[e-mail]',
    subject = 'My First Mail',
    attachments = 'path/to/attachment.txt'
)

The following table shows the properties that class Mail has.

Property	Type	Optional	Default	In Gmail
host	str	No	-	No
port	int	Yes	587	No
sender	str	Yes	None	Yes
recipients	str, list, tuple	Yes	None	Yes
subject	str	Yes	None	Yes
body	str	Yes	None	Yes
attachments	str, dict, bytes	Yes	None	Yes

Printing

It is possible to convert a Mail object to str or simply print it. For example, printing my_mail defined above:

>>> print(my_mail)
        My First Mail
        From: [e-mail]
        To:   

        (no body)

        attachment.txt

Edit an e-mail

You can create an e-mail and later edit its properties, by assigning them:

new_mail = Mail('smtp.host.com')
new_mail.recipients = ['[e-mail]', '[e-mail]']
new_mail.subject = 'Things I like'
new_mail.body = "Chocolate, pizza and postales!"

Sending

It is necessary to have the sender's password to be able to send the e-mail. In order to do it, use the send method, it will return True when done.

new_mail.send('supersecurepass1234.')