forked from themartorana/python-postmark
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
150 lines (119 loc) · 5.88 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
PMMail, PMBatchMail, and PMBounceManager objects, as well as Django email backend (postmark.django_backend.EmailBackend) for Postmark (http://postmarkapp.com)
CONTRIBUTORS:
Dave Martorana (themartorana)
Bill Jones (oraclebill)
Richard Cooper (frozenskys)
Miguel Araujo (maraujop)
Patrick Lauber (digi604)
Brian McFadden (brimcfadden)
Joel Ryan (joelryan2k)
Ben Hodgson (benhodgson)
Dmitry Golomidov (deeGraYve)
Matt Robenolt (mattrobenolt)
Maxime Bouroumeau-Fuseau (maximebf)
James Arthur (thruflo)
(Did I miss anyone?)
PYTHON INFORMATION:
Works on Python 2.4 and better. Versions
2.4 and 2.5 will require the "simplejson"
library from http://code.google.com/p/simplejson/
Python 2.6 has JSON support built in.
CHANGE LOG:
Version 0.3.2
- Uses simplejson if installed for faster C _speedups
- PMBatchMail properly chunks large message sets
- Django backend uses PMBatchMail properly
- Use https by default
- Proper testing API key out of the box
- Cleaned up some PMBatchMail properties
- Added a few utility methods (add_message, remove_message) to PMBatchMail
- Added proper value checking to PMBatchMail pre-send
- A BIG THANKS to all new contributors!
Version 0.3.1
- Added batch-messaging support (PMBatchMail object) (deeGraYve)
See http://developer.postmarkapp.com/developer-build.html#batching-messages
Version 0.2.3
- Merged in support for adding a tag through the Django backend (joelryan2k)
- Merged in support for POSTMARK_TEST_MODE overriding and beter settings defaults (benhodgson)
Version 0.2.2
- Merged in email mime import fix from brimcfadden
Version 0.2.1
- Merged in POSTMARK_TEST_MODE Django setting from maraujop
Version 0.2.0
- Merged with frozenskys/master to bring in PMBounceManager
- Support for multiple to/cc (limit: 20 per)
- Changed .recipient to .to (legacy support for .recipient left in)
- Tag support (.tag) added
- Fixed the email endpoint
- Fixed a Django backend issue for multiple recipients (max 20)
Version 0.1.6
- Added a new PMBounceManager Class that allows easy access to the PostMark
bounce API.
Version 0.1.5
- Added ".cc" property for carbon copy recipients. Changed django_backend to
support multiple recipients, and to use "to" rather than "recipients" on the django
mail object to prevent accidental leakage of BCC recipients.
Version 0.1.4
- Added ".reply_to" property. The "ReplyTo" custom header is unallowed by Postmark
now, and their documentation has been updated to reflect the change.
http://developer.postmarkapp.com
Version 0.1.3
- Major fix to the way properties were being used, fixes doc strings in properties
- "custom_headers" is now always a dict, even if set to None
Version 0.1.2
- Added 'custom_headers' property (must be a dictionary) to PMMail object
- Added optional 'test' argument to send function to print JSON message instead of actually sending it
Version 0.1.1:
- Initial release
USAGE:
Make sure you have a Postmark account. Visit
http://postmarkapp.com to sign up for an account.
Requires a Postmark API key.
Import postmark.PMMail to use Postmark. Check
class documentation on PMMail object for more
information.
DJANGO:
The library can be used stand-alone with Django. You can also
add the settings:
POSTMARK_API_KEY = 'your-key'
POSTMARK_SENDER = '[email protected]'
POSTMARK_TEST_MODE = [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 protected]' to
'Sender Name <[email protected]>' as long as the email part is
part of a Sender Signature in Postmark.
Using 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 send_mail() and
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.
EXCEPTIONS:
PMMailMissingValueException(Exception):
One of the required values for attempting a send request is missing
PMMailSendException(Exception):
Base Postmark send exception
PMMailUnauthorizedException(PMMailSendException):
401: Unathorized sending due to bad API key
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
PMMailServerErrorException(PMMailSendException):
500: Internal error - this is on the Postmark server side. Errors are
logged and recorded at Postmark.
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.
TODO:
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.