Skip to content

Latest commit

 

History

History
173 lines (125 loc) · 3.66 KB

README.md

File metadata and controls

173 lines (125 loc) · 3.66 KB

fluentmail Build Status Version

Tiny library to send email fluently

Install

pip install fluentmail

or

python setup.py install

Compatibility

Works with Python 2.6+ and PyPy, tested by Travis-CI.

Usage

Basic

from fluentmail import *

mail = FluentMail('smtp.gmail.com', 587, TLS)

mail.credentials('[email protected]', 'pwd')\
    .from_address('[email protected]')\
    .to('[email protected]')\
    .subject('FluentMail')\
    .body(u'Hi, I\'m FluentMail.')\
    .send()

To many receptors

from fluentmail import *

mail = FluentMail('smtp.gmail.com', 587, TLS)

mail.credentials('[email protected]', 'pwd')\
    .from_address('[email protected]')\
    .to('[email protected]')\
    .to('[email protected]')\
    .subject('FluentMail')\
    .body(u'Hi, I\'m FluentMail.')\
    .send()

or

from fluentmail import *

mail = FluentMail('smtp.gmail.com', 587, TLS)

mail.credentials('[email protected]', 'pwd')\
    .from_address('[email protected]')\
    .to(['[email protected]', '[email protected]'])\
    .subject('FluentMail')\
    .body(u'Hi, I\'m FluentMail.')\
    .send()

To, Cc, Bcc and Reply-To

from fluentmail import *

mail = FluentMail('smtp.gmail.com', 587, TLS)

mail.credentials('[email protected]', 'pwd')\
    .from_address('[email protected]')\
    .to('[email protected]')\
    .cc('[email protected]')\
    .bcc('[email protected]')\
    .reply_to('[email protected]')\
    .subject('FluentMail')\
    .body(u'Hi, I\'m FluentMail.')\
    .send()

HTML Body

from fluentmail import *

mail = FluentMail('smtp.gmail.com', 587, TLS)

mail.credentials('[email protected]', 'pwd')\
    .from_address('[email protected]')\
    .to('[email protected]')\
    .subject('FluentMail')\
    .body(u'<h2>Hi, I\'m FluentMail.<h2>')\
    .as_html()\
    .send()

With Attachment

from fluentmail import *

mail = FluentMail('smtp.gmail.com', 587, TLS)

mail.credentials('[email protected]', 'pwd')\
    .from_address('[email protected]')\
    .to('[email protected]')\
    .subject('FluentMail')\
    .body(u'<h2>Hi, I\'m FluentMail.<h2>', 'utf-8')\ # Body charset is optional.
    .as_html()\
    .attach('photo.png')\
    .attach('description.txt', 'utf-8')\ # Charset is optional, and only for Text files.
    .send()

Being more Pythonic

from fluentmail import *

mail = FluentMail('smtp.gmail.com', security=SSL, credentials=('user', 'pwd'))
mail.body(u'<h2>Hi, I\'m FluentMail.<h2>', 'utf-8', True)
mail.send(from_address='[email protected]',
          to=['[email protected]', '[email protected]'],
          cc=[],
          bcc=[],
          reply_to=[],
          subject='FluentMail')

Authentication type

NON_ENCRYPTED

mail = FluentMail('smtp.yoursite.com', 25, NON_ENCRYPTED)

SSL

mail = FluentMail('smtp.yoursite.com', 465, SSL)

TLS

mail = FluentMail('smtp.yoursite.com', 587, TLS)

By default SSL uses port 465, TLS uses 587 and AUTH 25.

For GMail you may want to read this security info.

Common smtp servers

Name Server Authentication Port
Gmail smtp.gmail.com SSL 465
Gmail smtp.gmail.com StartTLS 587
Hotmail smtp.live.com SSL 465
Mail.com smtp.mail.com SSL 465
Outlook.com smtp.live.com StartTLS 587
Office365.com smtp.office365.com StartTLS 587
Yahoo Mail smtp.mail.yahoo.com SSL 465

TODO

  • Docs
  • Unit tests
  • Test with others SMTP providers