Mandrill API Extension ¶

1. Installation
2. Set Up
3. Usage
4. Mandrill Templates
5. Additional Methods
6. Unit Testing
7. Logs

Mandrill Api Integration for Yii2
Version 1.2.0

Installation ¶

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist nickcv/yii2-mandrill "*"

or add

"nickcv/yii2-mandrill": "*"

to the require section of your composer.json file.

Set Up ¶

To use Mandrill you will need to have a Mandrill Account.

Every single account can send up to 12k emails per month for free.

The cost for sending emails over that threshold is really low.

Once you have an account you will need to create an API Key.
You can create as many API keys as you want, and it's best practice to create one for each website.
You can also create test API keys. Every email submitted using a test API key will not actually be submitted, but you'll be able to check inside the test dashboard if the test went thorugh successfully.

Mandrill will keep track of every single email you submit. You can filter the data using tags and you'll also be able to check how many times each email was opened and if the links within it have been clicked.

Usage ¶

Once the extension is installed, change your application config file `web.php`:

First of all you will need to add an `application name`. By default this extension will send every single email using the application name as the sender name and the `adminEmailparameter insideparams.php` as the sender email.

web.php

'id' => 'basic',
'name' => 'Application Name',

params.php

return [
    'adminEmail' => 'admin@example.com',
];

You will then need to add the component

web.php

'mailer' => [
        'class' => 'nickcv\mandrill\Mailer',
        'apikey' => 'YourApiKey',
    ],

From now on you can just use the mandrill mailer just as you used to use the default one.

\Yii::$app->mailer
    ->compose('mailViewName', ['model' => $model])
    ->setTo('email@email.com')
    ->send();

Mandrill Templates ¶

You can use Mandrill's own template system if you want to, just set up as true the `useMandrillTemplates` attribute in the component configuration

'mailer' => [
    'class' => 'nickcv\mandrill\Mailer',
    'apikey' => 'YourApiKey',
    'useMandrillTemplates' => true,
],

If you do turn this feature on the component will look for a template within mandrill named after the view argument of the compose method. If no view is found the component will then look for the view file inside the mail directory.

If neither is found an exception will be thrown as standard behavior.

Additional Methods ¶

Mandrill lets you set up tags. The method `\nickcv\mandrill\Message::setTags($tags)` accept as an argument both a string or an array of strings:

\Yii::$app->mailer
    ->compose('mailViewName', ['model' => $model])
    ->setTags(['registration']);

For more informations check the component documentation.

Unit Testing ¶

All the Classes within the package have been unit tested.
The tests are included within the package.

If you wish to run the tests install codeception following the Yii2 documentation.

The tests use the developer Mandrill Test API key which is only whitelisted for the developer IP.

Logs ¶

The component automatically logs every single message sent through mandrill, inside the "mandrill" category.

Messages sent successfully are logged using `\Yii::info()`, messages rejected or invalid are logged using `\Yii::warning()`, and all the exceptions thrown by the Mandrill Class are logged using `\Yii::error()`.

If you are using mandrill templates and the template is not found the error will be logged using `Yii::info()`.