Supports Python 2.7 and greater, including 3.x.
- Django email backend (postmark.django_backend.EmailBackend)
Make sure you have a Postmark account. Visit http://postmarkapp.com to sign up for an account. Requires a Postmark API key.
postmark.PMMail to use Postmark. Check class documentation on
PMMail object for more information.
The library can be used stand-alone with Django. You can also add the settings:
POSTMARK_API_KEY = 'your-key' POSTMARK_SENDER = 'firstname.lastname@example.org' POSTMARK_TEST_MODE = [True/False] POSTMARK_TRACK_OPENS = [True/False]
to your settings.py file, and when you create a new PMMail object, it will grab the API key and sender automatically. Make sure the sender email address is one of your Sender Signature email addresses in Postmark. You can also customize the name on the sender by changing the format from 'email@example.com' to 'Sender Name firstname.lastname@example.org' as long as the email part is part of a Sender Signature in Postmark.
POSTMARK_TEST_MODE=True will not actually send the email, but instead dump the JSON packet that would be sent to Postmarkapp.com. By default this setting is False, and if not specified, will be assumed to be False.
To reoute all Django E-Mail functions like
mail_admins() through postmark use the following setting:
EMAIL_BACKEND = 'postmark.django_backend.EmailBackend'
But keep in mind that even when using standard Django functions the sender must be registered with postmarkapp.com.
For tornado support of postmark implemented as Mixin.
Example of usage:
import tornado.web import tornado.options from postmark.tornado_mixin import PostmarkMixin tornado.options.define('postmark_signature', 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx') tornado.options.define('postmark_sendemail', 'email@example.com') class EmailHandler(tornado.web.RequestHandler, PostmarkMixin): def post(self): to = 'firstname.lastname@example.org' body = 'This is test message' subject = 'Test Message' self.send_email(body=body, to=to, subject=subject)
class PMMailMissingValueException(Exception): #One of the required values for attempting a send request is missing class PMMailSendException(Exception): #Base Postmark send exception class PMMailUnauthorizedException(PMMailSendException): #401: Unathorized sending due to bad API key class PMMailUnprocessableEntityException(PMMailSendException): # 422: Unprocessable Entity - usually an exception with either the sender not having a matching Sender Signature in Postmark. Read the message details for further information class PMMailServerErrorException(PMMailSendException): #500: Internal error - this is on the Postmark server side. Errors are logged and recorded at Postmark. class PMMailURLException(PMMailSendException): #A URLError was caught - usually has to do with connectivity and the ability to reach the server. The inner_exception will have the base URLError object. class PMMailInactiveRecipientException(PMMailSendException): # 406: You tried to send a message to a recipient that has been marked as inactive. If this was a batch operation, the rest of the messages were still sent.
- Add automatic multipart emails via regex stripping of HTML tags from html_body if the .multipart property is set to True
- Refactor PMBounceManager Object and improve error handling within it.
- Add PMBounceManager example to the Django test.
- Write tests for large percentage of coverage