netglue/zf2-mandrill-module

ZF2 Module that provides helpful services for sending template based mail via the Mandrill REST API

Mandrill Module for ZF2

This module is intended to provide painless integration of the Mandrill API, _(*1)

The module is not feature complete but what's here is reasonably tested., _(*2)

Install

Use composer: "netglue/zf2-mandrill-module" : "dev-develop", _(*3)

Add to modules with NetglueMandrillModule, _(*4)

Configure

Consult config/module.config.php, _(*5)

Available Services

• 'NetglueMandrill\Client\MandrillClient' - An API Client configured with your API Key
• 'NetglueMandrillModule\Factory\MandrillMessageFactory' - Creates Message instances with pre-configured defaults

Consult `config/, _(*6)

Currently...

...this module provides a service so you can easily create pre-configured messages easily. I use it primarily to populate template based messages like this:, _(*7)

'myMessageName' => array(
    'template_name' => 'my-template-name-on-mandrill',
    'message' => array(
        'from' => array(
            'name' => 'Me!',
            'email' => 'me@example.com',
        ),
        'subject' => 'Template Based Message',
    ),
),
// ...

// Later on, somewhere in your app:

$factory = $serviceLocator->get('NetglueMandrillModule\Factory\MandrillMessageFactory);
$message = $factory->createMessage('myMessageName');
$message->addRecipient('joe@example.com', 'Joe Bloggs', 'to');
$deliveryResult = $message->send();
var_dump($deliveryResult->isSuccess()); // true with any luck

See Also

The Guzzle backed API Client library, _(*8)

Tests

Requires phpunit 3.7 ish. May well work with newer or older versions., _(*9)

$ cd path/to/module
$ composer install
$ cd tests
$ nano|vi|whatever config/my.local.php
$ phpunit

Issues/Contributing

Contributions/fixes are much appreciated., _(*10)

Add issues to the tracker here, _(*11)