Skip to main content

Python wrapper for Postmark Inbound

Project description

POSTMARK INBOUND HOOK
=====================

This is a simple API wrapper for `Postmark Inbound Hook`_ in Python
inspired by `jjaffeux`_.

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
-----

.. code:: 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`_ 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
.. _Postmark Inbound Hook: http://developer.postmarkapp.com/developer-inbound.html
.. _jjaffeux: https://github.com/jjaffeux/postmark-inbound-php
.. _jjaffeux: https://github.com/jjaffeux/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for python-postmark-inbound, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size python-postmark-inbound-0.1.1.tar.gz (3.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page