PHPackages                             diningalliance/mandrill-yii2 - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail & Notifications](/categories/mail)
4. /
5. diningalliance/mandrill-yii2

ActiveYii2-extension[Mail & Notifications](/categories/mail)

diningalliance/mandrill-yii2
============================

Mandrill Api Integration for Yii2

06PHP

Since Oct 20Pushed 10y ago1 watchersCompare

[ Source](https://github.com/sumit-argusoft/diningalliance-mandrill)[ Packagist](https://packagist.org/packages/diningalliance/mandrill-yii2)[ RSS](/packages/diningalliance-mandrill-yii2/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Mandrill API Extension
======================

[](#mandrill-api-extension)

Mandrill Api Integration for Yii2
[![Latest Stable Version](https://camo.githubusercontent.com/2fdefdc8837c0e964ede6c4760332e8075b77765528c257c616538c9220528fb/68747470733a2f2f706f7365722e707567782e6f72672f6e69636b63762f796969322d6d616e6472696c6c2f762f737461626c65)](https://packagist.org/packages/nickcv/yii2-mandrill) [![Build Status](https://camo.githubusercontent.com/05aec25eaa3ff075dcb216957777f701f6a2fc2d2f3741e1e061a2882a7aa8e9/68747470733a2f2f7472617669732d63692e6f72672f6e69636b63762d6c6e2f796969322d6d616e6472696c6c2e737667)](https://travis-ci.org/nickcv-ln/yii2-mandrill) [![Total Downloads](https://camo.githubusercontent.com/e22f94d6a6f03efc49ad5343d33eaff9e2fbec216fe08ec89edc0303d41d9490/68747470733a2f2f706f7365722e707567782e6f72672f6e69636b63762f796969322d6d616e6472696c6c2f646f776e6c6f616473)](https://packagist.org/packages/nickcv/yii2-mandrill) [![License](https://camo.githubusercontent.com/3c21a9853a3408cabecdd8dfc3fce74366174bfa25c7d1b0c014a947733d9def/68747470733a2f2f706f7365722e707567782e6f72672f6e69636b63762f796969322d6d616e6472696c6c2f6c6963656e7365)](https://packagist.org/packages/nickcv/yii2-mandrill)

Installation
------------

[](#installation)

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

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
------

[](#set-up)

To use Mandrill you will need to have a [Mandrill Account](https://mandrill.com/signup/).

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

The [cost for sending emails over that threshold is really low](https://mandrill.com/pricing/).

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
-----

[](#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 `adminEmail` parameter inside `params.php` as the sender email.

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

```

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

```

You will then need to add the component

```
    '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
------------------

[](#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.

Since **version 1.3.0** the component will stop falling back to rendering the internal views. This change has been made because now the mandrill send-template method will be used, avoiding to make two API calls when templates are enabled.

Since **version 1.4.0** the component won't default to the application name and admin email when using mandrill templates. This has been done to allow the use of Mandrill defaults values for the template.

To override this behavior you can set to false the `useTemplateDefaults` attribute in the component configuration

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

```

Since **version 1.5.0** the component has a configurable property `templateLanguage` that can contain either 'mailchimp' or 'handlebars' ('mailchimp' is by default).

For more information about handlebars usage check these links:

- [Mandrill docs](https://mandrill.zendesk.com/hc/en-us/articles/205582537-Using-Handlebars-for-dynamic-content)
- [Handlebars docs](http://handlebarsjs.com/)

You can change preferred language by editing `templateLanguage` attribute in the component configuration

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

```

Additional Methods
------------------

[](#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']);

```

Since **version 1.3.0** it's also possible to enable the async mode. When using async mode mandrill will queue the messages and send em in batches. If you send a message to more than 10 email addresses async mode will be used automatically.

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

```

Since **version 1.4.0** it's also possible to use global merge vars. This variables will be use to replace placeholders by mandrill. This is especially useful when dealing with templates.

Since **version 1.6.0** you can get the Mandrill object used by the component calling the `Mailer::getMandrill` method.

For more informations check the component documentation.

Unit Testing
------------

[](#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
----

[](#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()`.

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/d305688352406cea2662be471640932983fba8cb1a8c350446f54e043a2f08a8?d=identicon)[sumitalive](/maintainers/sumitalive)

---

Top Contributors

[![sumit-argusoft](https://avatars.githubusercontent.com/u/11648625?v=4)](https://github.com/sumit-argusoft "sumit-argusoft (3 commits)")

### Embed Badge

![Health badge](/badges/diningalliance-mandrill-yii2/health.svg)

```
[![Health](https://phpackages.com/badges/diningalliance-mandrill-yii2/health.svg)](https://phpackages.com/packages/diningalliance-mandrill-yii2)
```

###  Alternatives

[minishlink/web-push

Web Push library for PHP

1.9k12.0M53](/packages/minishlink-web-push)[laravel-notification-channels/twilio

Provides Twilio notification channel for Laravel

2587.7M12](/packages/laravel-notification-channels-twilio)[spatie/url-signer

Generate a url with an expiration date and signature to prevent unauthorized access

4422.3M16](/packages/spatie-url-signer)[mattketmo/email-checker

Throwaway email detection library

2742.0M5](/packages/mattketmo-email-checker)[laravel-notification-channels/discord

Laravel notification driver for Discord.

2371.3M11](/packages/laravel-notification-channels-discord)[eduardokum/laravel-mail-auto-embed

Library for embed images in emails automatically

1702.0M5](/packages/eduardokum-laravel-mail-auto-embed)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)