freax/mandrill-zend2

A PHP client library for Mandrill's REST API for Zend Framework 2 (>=2.5)

2.1 2015-10-27 12:16 UTC

Requires

• php: >=5.5
• zendframework/zend-http: ~2.5
• zendframework/zend-json: ~2.5
• zendframework/zend-mail: ~2.5

Requires (Dev)

• phpunit/phpunit: 3.7.*

MIT

• Freax

• zf2
• mandrill

README

A PHP ZF2 (>=2.5) client library for Mandrill's API.

This library provides all of the functionality present in the official PHP client, but makes use of namespaces, provides helper classes to ease message sending and works with Zend Framework 2 (>=2.5) (uses its library).

This library based on Joe Linn's library (https://github.com/jlinn/mandrill-api-php).

Installation Using Composer

Assuming composer.phar is located in your project's root directory, run the following command:

php composer.phar require freax/mandrill-zend2:2.*

Usage

Sending a Message

use Mandrill\Mandrill;
use Mandrill\Struct\Message;
use Mandrill\Struct\Recipient;

// instantiate a client object
$mandrill = new Mandrill('your_api_key');

// instantiate a Message object
$message = new Message();

// define message properties
$message->text = 'Hello, *|NAME|*!';
$message->subject = 'Test';
$message->from_email = '[e-mail]';
$message->from_name = 'Mandrill API Test';

// instantiate a Recipient object and add details
$recipient = new Recipient();
$recipient->email = '[e-mail]';
$recipient->name = 'Recipient Name';
$recipient->addMergeVar('NAME', $recipient->name);

// add the recipient to the message
$message->addRecipient($recipient);

// send the message
$response = $mandrill->messages()->send($message);

Sending a ZF2 Message

use Mandrill\Mandrill;
use Mandrill\Struct\Message;

// convert from ZF message
// $zfMessage is instance of \Zend\Mail\Message
$message = Message::convertZFMail($zfMessage);

// add any field you want
$message->metadata = ...;

// instantiate a client object
$mandrill = new Mandrill('your_api_key');

// send the message
$response = $mandrill->messages()->send($message);