Skip to main content

A Python library for the Postmark API (http://developer.postmarkapp.com/).

Project description

# pystmark

[Postmark API](http://developer.postmarkapp.com/) library for python 2.6 and 2.7.
Built on top of the [requests](http://docs.python-requests.org/en/latest/) library.

[![Build Status](https://travis-ci.org/xsleonard/pystmark.png)](https://travis-ci.org/xsleonard/pystmark)


## Documentation

The full Sphinx-compiled documentation is available here: [https://readthedocs.org/docs/pystmark/en/latest/](https://readthedocs.org/docs/pystmark/en/latest/)

## Example Usage

```python
import pystmark

API_KEY = 'my_api_key'
SENDER = 'me@example.com'

# Send a single message
message = pystmark.PystMessage(sender=SENDER, to='you@example.com',
subject='Hi', text='A message', tag='greeting')
pystmark.send(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.PystMessage(sender=SENDER, to=to, subject='Hi',
text='A message', tag='greeting')
for to in recipients]

response = pystmark.send_batch(messages, api_key=API_KEY)

# Check API response error
try:
response.raise_for_status()
except pystmark.PystUnauthorizedError:
print 'Use your real API key'

```


## Contribution

1. Fork this repo
2. Make your changes and write a test for them
3. Add yourself to the AUTHORS file and submit a pull request

Please run the tests with `./setup.py test --with-integration` before you make
a pull request. Requirements for running the tests are in
`tests/requirements.pip`.


## Web Framework Integration

If you would like to integrate this with some web framework, write a separate
module and I'll link to it from here.


## Copyright and License

pystmark is licensed under the MIT license. See the LICENSE file for full details.

Project details


Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page