postmark-inbound-php - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #typescript #golang #go #machine-learning #java #windows #kubernetes #awesome-list #vue #pytorch #ios #open-source

postmark-inbound-php

(★ 97)

Simple API wrapper for Postmark Inbound Hook

File Explorer

Download Latest Version (.zip)

- - composer.json
  - composer.lock
  - composer.phar
  - index.php
- - index.php
- inbound.json
- - Attachment.php
  - Attachments.php
  - Autoloader.php
  - Inbound.php
  - InboundException.php
- bootstrap.php
.gitignore
.travis.yml
CHANGELOG.md
composer.json
LICENSE
phpunit.xml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/jjaffeux/postmark-inbound-php

Downloads the entire project code from GitHub to your computer.

cd postmark-inbound-php

Moves into the project folder you just downloaded.

2. PHP (Composer)

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer install

Installs the PHP libraries listed in composer.json.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

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

This is a simple API wrapper for Postmark Inbound Hook (http://developer.postmarkapp.com/developer-inbound-webhook.html)

[![Build Status](https://secure.travis-ci.org/jjaffeux/postmark-inbound-php.png?branch=master)](http://travis-ci.org/jjaffeux/postmark-inbound-php)

Setup
-----
With composer :
``` json
{
    "require": {
        "jjaffeux/postmark-inbound-php": ">=3.0"
    }
}
```
``` php
$inbound = new \Postmark\Inbound(file_get_contents('php://input'));
```

Without composer :
``` php
require_once '../lib/Postmark/Autoloader.php';
\Postmark\Autoloader::register();

// this file should be the target of the callback you set in your postmark account
$inbound = new \Postmark\Inbound(file_get_contents('php://input'));
```

General Usage
-------------

``` php
$inbound->Subject();
$inbound->FromEmail();
$inbound->FromFull();
$inbound->FromName();
$inbound->Date();
$inbound->OriginalRecipient();
$inbound->ReplyTo();
$inbound->MailboxHash();
$inbound->Tag();
$inbound->MessageID();
$inbound->TextBody();
$inbound->HtmlBody();
$inbound->StrippedTextReply();
```

Headers
-------

``` php
$inbound->Headers(); //default to spam status
$inbound->Headers('X-Spam-Status');
$inbound->Headers('X-Spam-Checker-Version');
$inbound->Headers('X-Spam-Score');
$inbound->Headers('X-Spam-Tests');
$inbound->Headers('Received-SPF');
$inbound->Headers('MIME-Version');
$inbound->Headers('Received-SPF'); // pass neutral fail
$inbound->Headers('Message-ID');
```

Recipients and Undisclosed Recipients
-------------------------------------

``` php
foreach($inbound->Recipients() as $recipient) {
	$recipient->Name;
	$recipient->Email;
}

foreach($inbound->UndisclosedRecipients() as $undisclosedRecipient) {
	$undisclosedRecipient->Name;
	$undisclosedRecipient->Email;
}
```

Attachments
-------------------------------------

``` php
foreach($inbound->Attachments() as $attachment) {
	$attachment->Name;
	$attachment->ContentType;
	$attachment->ContentLength;
	$attachment->Download('/'); //takes directory as first argument
}

$inbound->HasAttachments();
```

Raw
---

``` php
$inbound->Source; //array
$inbound->Json; //raw json
```

Bug tracker
-----------

Have a bug? Please create an issue here on GitHub!

Contributions
-------------

* Fork
* Write tests (phpunit in the directory to run the tests)
* Write Code
* Pull request

Thanks for your help.

Authors
-------

**Joffrey Jaffeux**

+ http://twitter.com/joffreyjaffeux
+ http://github.com/jjaffeux

Inspiration
-----------

Thx to Randy Schmidt for the original ruby wrapper

+ https://github.com/r38y
+ http://forge38.com/

Other libraries
---------------

+ Ruby : https://github.com/r38y/postmark-mitt
+ Python : https://github.com/jpadilla/postmark-inbound-python

License
---------------------

MIT License