A Python library for the Postmark API (http://developer.postmarkapp.com/).
Project description
pystmark
Postmark API library for python 2.7, 3.6 and pypy. Built on top of the requests library.
Web Framework Integration
Documentation
The full Sphinx-compiled documentation is available here: https://readthedocs.org/docs/pystmark/en/latest/
Example Usage
import pystmark
API_KEY = 'my_api_key'
SENDER = 'me@example.com'
# Send a single message
message = pystmark.Message(
sender=SENDER, to='you@example.com', subject='Hi', text='A message', tag='greeting'
)
response = pystmark.send(message, api_key=API_KEY)
# Send a template message
t_model = {
'product_name': 'Awesome Product',
'name': 'Customer Name',
'action_url': 'http://www.example.com/confirmation/aj3s5dopf98sdf',
'sender_name': 'Product Team',
'product_address_line1': 'Dover',
'product_address_line2': 'DE 19012',
}
message = pystmark.Message(
sender=SENDER,
to='you@example.com',
template_id=11111,
template_model=t_model,
tag='welcome',
)
response = pystmark.send_with_template(message, api_key=API_KEY)
# Send multiple messages (via Postmark's batch send API)
recipients = ['you{0}@example.com'.format(i) for i in xrange(20)]
messages = [
pystmark.Message(
sender=SENDER,
to=to,
subject='Hi',
text='A message',
tag='greeting',
message_stream='broadcasts',
)
for to in recipients
]
response = pystmark.send_batch(messages, api_key=API_KEY)
# Send multiple messages with templates
recipients = ['you{0}@example.com'.format(i) for i in xrange(20)]
messages = [
pystmark.Message(
sender=SENDER,
to=to,
template_id=11111,
template_model=t_model,
tag='greeting',
message_stream='broadcasts',
)
for to in recipients
]
response = pystmark.send_batch_with_templates(messages, api_key=API_KEY)
# Check API response error
try:
response.raise_for_status()
except pystmark.UnauthorizedError:
print 'Use your real API key'
Contribution
- Fork this repo
- Make your changes and write a test for them
- Add yourself to the AUTHORS.md file and submit a pull request
Please run the tests with ./setup.py test --with-integration
, with at least python2.7,
before you make a pull request. Requirements for running the tests are in tests/requirements.txt
.
The other versions will be handled by travis-ci.
The pep8 tests may fail if using pypy due to this bug, so that test is disabled if pypy is detected.
Copyright and License
pystmark is licensed under the MIT license. See the LICENSE file for full details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.