Postmark plugin for CakePHP

CakePHP plugin that makes email delivery using Postmark

Version

Written for CakePHP 2.x

Copyright

Copyright (c) 2011 Maury M. Marques

Installation

You can clone the plugin into your project (or if you want you can use as a submodule):

cd path/to/app/Plugin or /plugins
git clone https://github.com/maurymmarques/postmark-cakephp.git Postmark

Bootstrap the plugin in app/Config/bootstrap.php:

CakePlugin::load('Postmark');

Configuration

Create the file app/Config/email.php with the class EmailConfig.

class EmailConfig {
	public $postmark = array(
		'transport' => 'Postmark.Postmark',
		'uri' => 'http://api.postmarkapp.com/email',
		'key' => 'your-key-postmark'
	);
}

If you want your connection to Postmark to be encrypted, simply change the uri to use https.

Make sure to modified the API key to match the credentials for your Postmark server rack instance.

Usage

This plugin uses CakeEmail, and works virtually the same.

Then, simply send messages like this:

App::uses('CakeEmail', 'Network/Email');
$email = new CakeEmail();

$email->config('postmark');
$email->from('[email protected]');
$email->to('[email protected]');
$email->subject('Test Postmark');
$email->send('Message');

Or use more resources:

App::uses('CakeEmail', 'Network/Email');
$email = new CakeEmail();

$email->config('postmark');
$email->template('default', 'default');
$email->emailFormat('html');
$email->viewVars(array('name' => 'Your Name'));
$email->from(array('[email protected]' => 'Your Name'));
$email->to(array('[email protected]' => 'Recipient1', '[email protected]' => 'Recipient2'));
$email->cc(array('[email protected]' => 'Recipient3', '[email protected]' => 'Recipient4'));
$email->bcc(array('[email protected]' => 'Recipient5', '[email protected]' => 'Recipient6'));
$email->subject('Test Postmark');
$email->addHeaders(array('Tag' => 'my tag'));
$email->attachments(array(
    'cake.icon.png' => array(
        'file' => WWW_ROOT . 'img' . DS . 'cake.icon.png'
	)
));

$email->send();

If you need the instance of the class PostmarkTrasport:

App::uses('CakeEmail', 'Network/Email');
$email = new CakeEmail();

$postmarkInstance = $email->transport('Postmark.Postmark')->transportClass();

The syntax of all parameters is the same as the default CakeEmail:

http://book.cakephp.org/2.0/en/core-utility-libraries/email.html

For more information, see the Postmark API documentation:

http://developer.postmarkapp.com/#message-format

Debugging

You can see the response from Postmark in the return value when you send a message:

$result = $email->send('Message');
$this->log($result, 'debug');

If there are any errors, they'll be included in the response. See the Postmark API documentation for error code detail:

http://developer.postmarkapp.com/#api-error-codes

CakePHP 1.3+

This class does not work for CakePHP 1.3, for this see:

https://github.com/danielmcormond/postmark-cakephp