README

This extension provides a MailGun mail solution for Yii framework 2.0.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist bsadnu/yii2-mailgunmailer "*"

or add

"bsadnu/yii2-mailgunmailer": "*"

to the require section of your composer.json.

Usage

To use this extension, simply add the following code in your application configuration:

'components' => [
    ...
    'mailer' => [
        'class' => 'bsadnu\mailgunmailer\Mailer',
        'key' => 'MailGun API Key',
        'domain' => 'domain.name',
    ],
    ...
],

You can then send an email as follows:

Yii::$app
    ->mailer
    ->compose(
        ['html' => 'someTemplate-html', 'text' => 'someTemplate-text'],
        ['someVariable' => $someVariable]
    )
    ->setFrom('from@example.com')
    ->setTo('to@example.com')
    ->setSubject('Some subject')
    ->send();

License

yii2-mailgunmailer is released under the BSD 2-Clause License. See the bundled LICENSE for details.