221 lines
6.1 KiB
ReStructuredText
221 lines
6.1 KiB
ReStructuredText
python-emails
|
|
=============
|
|
|
|
Modern email handling in python.
|
|
|
|
.. code-block:: python
|
|
|
|
m = emails.Message(html=T("<html><p>Build passed: {{ project_name }} <img src='cid:icon.png'> ..."),
|
|
text=T("Build passed: {{ project_name }} ..."),
|
|
subject=T("Passed: {{ project_name }}#{{ build_id }}"),
|
|
mail_from=("CI", "ci@mycompany.com"))
|
|
m.attach(filename="icon.png", content_disposition="inline", data=open("icon.png"))
|
|
response = m.send(render={"project_name": "user/project1", "build_id": 121},
|
|
to='somebody@mycompany.com',
|
|
smtp={"host":"mx.mycompany.com", "port": 25})
|
|
|
|
if response.status_code not in [250, ]:
|
|
# message is not sent, retry later
|
|
...
|
|
|
|
See `the same code, without Emails <https://gist.github.com/lavr/fc1972c125ccaf4d4b91>`_.
|
|
|
|
Emails code is not much simpler than `the same code in django <https://gist.github.com/lavr/08708b15d33fc2ad718b>`_,
|
|
but it is still more elegant, can be used in django environment and has html transformation methods
|
|
(see ``HTML Transformer`` section).
|
|
|
|
|
|
Features
|
|
--------
|
|
|
|
- HTML-email message abstraction
|
|
- Method to transform html body:
|
|
|
|
- css inlining (using peterbe's premailer)
|
|
- image inlining
|
|
- DKIM signature
|
|
- Message loaders
|
|
- Send directly or via django email backend
|
|
|
|
|
|
Examples
|
|
--------
|
|
|
|
Create message:
|
|
|
|
.. code-block:: python
|
|
|
|
import emails
|
|
message = emails.html(html=open('letter.html'),
|
|
subject='Friday party',
|
|
mail_from=('Company Team', 'contact@mycompany.com'))
|
|
|
|
|
|
Attach files or inline images:
|
|
|
|
.. code-block:: python
|
|
|
|
message.attach(data=open('event.ics'), filename='Event.ics')
|
|
message.attach(data=open('image.png'), filename='image.png',
|
|
content_disposition='inline')
|
|
|
|
Use templates:
|
|
|
|
.. code-block:: python
|
|
|
|
from emails.template import JinjaTemplate as T
|
|
|
|
message = emails.html(subject=T('Payment Receipt No.{{ billno }}'),
|
|
html=T('<p>Dear {{ name }}! This is a receipt...'),
|
|
mail_from=('ABC', 'robot@mycompany.com'))
|
|
|
|
message.send(to=('John Brown', 'jbrown@gmail.com'),
|
|
render={'name': 'John Brown', 'billno': '141051906163'})
|
|
|
|
|
|
|
|
Add DKIM signature:
|
|
|
|
.. code-block:: python
|
|
|
|
message.dkim(key=open('my.key'), domain='mycompany.com', selector='newsletter')
|
|
|
|
Generate email.message or rfc822 string:
|
|
|
|
.. code-block:: python
|
|
|
|
m = message.as_message()
|
|
s = message.as_string()
|
|
|
|
|
|
Send and get response from smtp server:
|
|
|
|
.. code-block:: python
|
|
|
|
r = message.send(to=('John Brown', 'jbrown@gmail.com'),
|
|
smtp={'host':'smtp.mycompany.com', 'port': 465, 'ssl': True})
|
|
assert r.status_code == 250
|
|
|
|
Or send via Django email backend:
|
|
|
|
.. code-block:: python
|
|
|
|
from django.core.mail import get_connection
|
|
from emails.message import DjangoMessageProxy
|
|
c = django.core.mail.get_connection()
|
|
c.send_messages([DjangoMessageProxy(message), ])
|
|
|
|
|
|
HTML transformer
|
|
----------------
|
|
|
|
Message HTML body can be modified with 'transformer' object:
|
|
|
|
.. code-block:: python
|
|
|
|
>>> message = emails.Message(html="<img src='promo.png'>")
|
|
>>> message.transformer.apply_to_images(func=lambda src, **kw: 'http://mycompany.tld/images/'+src)
|
|
>>> message.transformer.save()
|
|
>>> message.html
|
|
u'<html><body><img src="http://mycompany.tld/images/promo.png"></body></html>'
|
|
|
|
Code example to make images inline:
|
|
|
|
.. code-block:: python
|
|
|
|
>>> message = emails.Message(html="<img src='promo.png'>")
|
|
>>> message.attach(filename='promo.png', data=open('promo.png'))
|
|
>>> message.attachments['promo.png'].is_inline = True
|
|
>>> message.transformer.synchronize_inline_images()
|
|
>>> message.transformer.save()
|
|
>>> message.html
|
|
u'<html><body><img src="cid:promo.png"></body></html>'
|
|
|
|
|
|
Loaders
|
|
-------
|
|
|
|
python-emails ships with couple of loaders.
|
|
|
|
Load message from url:
|
|
|
|
.. code-block:: python
|
|
|
|
import emails.loader
|
|
message = emails.loader.from_url(url="http://xxx.github.io/newsletter/2015-08-14/index.html")
|
|
|
|
|
|
Load from zipfile or directory:
|
|
|
|
.. code-block:: python
|
|
|
|
message = emails.loader.from_zipfile(open('design_pack.zip'))
|
|
message = emails.loader.from_directory('/home/user/design_pack')
|
|
|
|
Zipfile and directory loaders require at least one html file (with "html" extension).
|
|
|
|
|
|
Install
|
|
-------
|
|
|
|
Install from pypi:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ [sudo] pip install emails
|
|
|
|
Install on Ubuntu from PPA:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ [sudo] add-apt-repository ppa:lavrme/python-emails-ppa
|
|
$ [sudo] apt-get update
|
|
$ [sudo] apt-get install python-emails
|
|
|
|
|
|
TODO
|
|
----
|
|
|
|
- Documentation
|
|
- Increase test coverage
|
|
- Feature: load message from rfc2822
|
|
- Feature: export message to directory or zipfile
|
|
- Performance: Patch pydkim for performance: i.e. preload key only once
|
|
- Distribution: deb package (`debianization example <https://github.com/lavr/python-emails-debian/>`_)
|
|
- Distribution: rpm package
|
|
- Other: Flask extension
|
|
- Feature: ESP integration - Amazon SES, SendGrid, ...
|
|
|
|
|
|
How to Help
|
|
-----------
|
|
|
|
Library is under development and contributions are welcome.
|
|
|
|
1. Open an issue to start a discussion around a bug or a feature.
|
|
2. Fork the repository on GitHub and start making your changes to a new branch.
|
|
3. Write a test which shows that the bug was fixed.
|
|
4. Send a pull request. Make sure to add yourself to `AUTHORS <https://github.com/lavr/python-emails/blob/master/README.rst>`_.
|
|
|
|
|
|
See also
|
|
--------
|
|
|
|
There are plenty other python email-around libraries:
|
|
|
|
- premailer https://github.com/peterbe/premailer
|
|
- pyzmail http://www.magiksys.net/pyzmail/
|
|
- ...
|
|
|
|
.. image:: https://travis-ci.org/lavr/python-emails.png?branch=master
|
|
:target: https://travis-ci.org/lavr/python-emails
|
|
|
|
.. image:: https://img.shields.io/pypi/v/emails.svg
|
|
:target: https://pypi.python.org/pypi/emails
|
|
|
|
.. image:: http://allmychanges.com/p/python/emails/badge/
|
|
:target: http://allmychanges.com/p/python/emails/?utm_source=badge
|
|
|
|
.. image:: https://coveralls.io/repos/lavr/python-emails/badge.svg?branch=master
|
|
:target: https://coveralls.io/r/lavr/python-emails?branch=master
|