jlinn/mandrill-api-php

A PHP client library for Mandrill's REST API

mandrill-api-php

, _(*1)

A PHP client library for Mandrill's API., _(*2)

This library provides all of the functionality present in the official PHP client, but makes use of namespaces and provides helper classes to ease message sending., _(*3)

Installation Using Composer

Assuming composer.phar is located in your project's root directory, run the following command:, _(*4)

php composer.phar require jlinn/mandrill-api-php:~1.0

Usage

Sending a Message

use Jlinn\Mandrill\Mandrill;
use Jlinn\Mandrill\Struct\Message;
use Jlinn\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 = 'test@example.com';
$message->from_name = 'Mandrill API Test';

// instantiate a Recipient object and add details
$recipient = new Recipient();
$recipient->email = 'recipient.email@example.com';
$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);

Usage with Laravel 4.x

We have built a factory so that it's easier to use with Laravel 4.x facades., _(*5)

Configuration

In order to publish the package configuration you need to perform the following command:, _(*6)

php artisan config:publish jlinn/mandrill-api-php

Change then the secret variable with your Mandrill secret key., _(*7)

Sending a Message

```php, <sub>(*8)</sub>

// instantiate a client object $api = Mandrill::api();, <sub>(*9)</sub>

// instantiate a message object $message = Mandrill::message([ 'text' => 'Hello, |NAME|!', 'subject' => 'Test', 'from_email' => 'test@example.com', 'from_name' => 'Mandrill API Test' ]);, <sub>(*10)</sub>

// instantiate a Recipient object and add details $recipient = Mandrill::recipient('recipient.email@example.com', 'Recipient Name'); $recipient->addMergeVar('NAME', $recipient->name);, <sub>(*11)</sub>

// add the recipient to the message $message->addRecipient($recipient);, <sub>(*12)</sub>

// send the message $response = $api->messages()->send($message);, <sub>(*13)</sub>