Python wrapper for Postmark Inbound
Project description
Postmark Inbound Hook [![Build Status](https://travis-ci.org/jpadilla/postmark-inbound-python.png?branch=master)](https://travis-ci.org/jpadilla/postmark-inbound-python)
=====================
This is a simple API wrapper for [Postmark Inbound Hook](http://developer.postmarkapp.com/developer-inbound.html)
in Python inspired by [jjaffeux](https://github.com/jjaffeux/postmark-inbound-php).
## Install
Using Github:
```
git clone git@github.com:jpadilla/postmark-inbound-python.git
```
Using pip:
```
pip install python-postmark-inbound
```
Using easy_install:
```
easy_install python-postmark-inbound
```
Usage
-----
``` python
from postmark_inbound import PostmarkInbound
# load json
json_data = open('./tests/fixtures/valid_http_post.json').read()
inbound = PostmarkInbound(json=json_data)
# content
inbound.subject()
inbound.sender()
inbound.to()
inbound.bcc()
inbound.tag()
inbound.message_id()
inbound.mailbox_hash()
inbound.reply_to()
inbound.html_body()
inbound.text_body()
inbound.send_date()
# headers
inbound.headers() # default to get Date
inbound.headers('MIME-Version')
inbound.headers('Received-SPF')
# spam
inbound.headers('X-Spam-Checker-Version')
inbound.headers('X-Spam-Score')
inbound.headers('X-Spam-Tests')
inbound.headers('X-Spam-Status')
# attachments
inbound.has_attachments() # boolean
attachments = inbound.attachments()
first_attachment = attachments[0]
first_attachment.name()
second_attachment = attachments[1]
second_attachment.content_length()
for a in attachments:
a.name()
a.content_type()
a.content_length()
a.download('./tests/', ['image/png'], '10000')
# raw data
inbound.json
inbound.source
```
Bug tracker
-----------
Have a bug? Please create an issue here on GitHub!
Contributions
-------------
* Fork
* Write tests
* Write Code
* Pull request
Thanks for your help.
TODO
----
* Write more tests
Authors
-------
**José Padilla**
+ http://twitter.com/jpadilla_
+ http://github.com/jpadilla
Inspiration
-----------
Thanks to [jjaffeux](https://github.com/jjaffeux/) for the original PHP wrapper
+ https://github.com/jjaffeux
+ https://github.com/jjaffeux/postmark-inbound-php
Other libraries
---------------
+ Ruby: https://github.com/r38y/postmark-mitt
+ PHP: https://github.com/jjaffeux/postmark-inbound-php
+ Node.js + CouchDB: https://gist.github.com/1647808
License
---------------------
MIT License
=====================
This is a simple API wrapper for [Postmark Inbound Hook](http://developer.postmarkapp.com/developer-inbound.html)
in Python inspired by [jjaffeux](https://github.com/jjaffeux/postmark-inbound-php).
## Install
Using Github:
```
git clone git@github.com:jpadilla/postmark-inbound-python.git
```
Using pip:
```
pip install python-postmark-inbound
```
Using easy_install:
```
easy_install python-postmark-inbound
```
Usage
-----
``` python
from postmark_inbound import PostmarkInbound
# load json
json_data = open('./tests/fixtures/valid_http_post.json').read()
inbound = PostmarkInbound(json=json_data)
# content
inbound.subject()
inbound.sender()
inbound.to()
inbound.bcc()
inbound.tag()
inbound.message_id()
inbound.mailbox_hash()
inbound.reply_to()
inbound.html_body()
inbound.text_body()
inbound.send_date()
# headers
inbound.headers() # default to get Date
inbound.headers('MIME-Version')
inbound.headers('Received-SPF')
# spam
inbound.headers('X-Spam-Checker-Version')
inbound.headers('X-Spam-Score')
inbound.headers('X-Spam-Tests')
inbound.headers('X-Spam-Status')
# attachments
inbound.has_attachments() # boolean
attachments = inbound.attachments()
first_attachment = attachments[0]
first_attachment.name()
second_attachment = attachments[1]
second_attachment.content_length()
for a in attachments:
a.name()
a.content_type()
a.content_length()
a.download('./tests/', ['image/png'], '10000')
# raw data
inbound.json
inbound.source
```
Bug tracker
-----------
Have a bug? Please create an issue here on GitHub!
Contributions
-------------
* Fork
* Write tests
* Write Code
* Pull request
Thanks for your help.
TODO
----
* Write more tests
Authors
-------
**José Padilla**
+ http://twitter.com/jpadilla_
+ http://github.com/jpadilla
Inspiration
-----------
Thanks to [jjaffeux](https://github.com/jjaffeux/) for the original PHP wrapper
+ https://github.com/jjaffeux
+ https://github.com/jjaffeux/postmark-inbound-php
Other libraries
---------------
+ Ruby: https://github.com/r38y/postmark-mitt
+ PHP: https://github.com/jjaffeux/postmark-inbound-php
+ Node.js + CouchDB: https://gist.github.com/1647808
License
---------------------
MIT License
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for python-postmark-inbound-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72686a67235f19d4c88d39bd459809cf20cd74f6d8ed7d013fb920e4d089e41c |
|
MD5 | ad8ef024e93f461c300c9fde4735699a |
|
BLAKE2b-256 | 1594f188be1f951ce0ca0aeefe748d28b91ae7bf8661d1b2dac638d8e7b04d9c |
Close
Hashes for python_postmark_inbound-1.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fdf2585238dc8d5da91e7a0dfb30b0856e55519f5828fb0ceea53582c634635e |
|
MD5 | 47b66399ab959512d47ef2e331b25f53 |
|
BLAKE2b-256 | fe7e8f84c2343cdfdd3b6f23fd16cce837e31504386444b5fab9271662525489 |