It makes sending mail easier. The main features:

1. It allows you specify message headers by keyword arguments.
2. Support interactive prompt for username or password.
3. Support optional with statement.

It is an example which sends a mail from Python shell.

>>> from postbox import Postbox, Gmail

>>> gmail = Postbox(host='smtp.google.com:587') # or gmail = Gmail()
username? [email protected]
password?

>>> gmail.send(
...     to = ['[email protected]', '[email protected]'],
...     bcc = '[email protected]',
...     subject = 'Test from Python Shell',
...     body = 'It is sent by postbox. :)'
... )
...

>>> gmail.close()
>>>

You can find more examples here.

The Postbox (or Gmail) accepts the following keyword arguments:

1. host: the hostname of your SMTP server. ex. 'smtp.google.com' or 'smtp.google.com:587'
2. port: the port number of your SMTP server.
3. user: the username.
4. password: the password.
5. tls: use tls or not.
6. prompt_user: prompt string if you don't specify user.
7. prompt_password: prompt string if you don't specify password.
8. debuglevel: the debuglevel.
9. dry_run: don't send the mail out.

The all keyword arguments to send will be translated into message headers, except the body is the body of this mail. The common headers list:

1. to: It is also used as the to_addrs, so you must to specify it.
2. from_: It is also used as the from_addr. If you don't specify it, it takes the user from Postbox instance as default.
3. subject
4. cc
5. bcc
6. reply_to

If a value is iterable but not a string, it will be joined into a string by comma.