darkair/yii2-mailtank

Yii2 extension for Mailtank Client

dev-master 2014-07-09 11:24 UTC

Requires

• php: >=5.4.0
• darkair/yii2-console: master
• darkair/yii2-mailtank-client: master
• darkair/yii2-sentry-log: master

Requires (Dev)

• yiisoft/yii2: dev-master

BSD

• Dmitry DarkAiR Romanov

• client
• extension
• yii2
• mailtank

README

Yii2 Mailtank (mailtank.ru) extension

Installation

Install package

The preferred way to install this extension is through composer.

Either run

$ php composer.phar require darkair/yii2-mailtank "dev-master"

or add

"darkair/yii2-mailtank": "dev-master"

to the require section of your composer.json file.

Migration

You have to copy migrations to your 'migrations' directory cp vendor/darkair/yii2-mailtank/src/migrations/* migrations Then you have to run migrate command for creating DB tables.

Usage

Add target class in your project config:

'components' => [
    'mailtank' => [
        'class' => 'mailtank\Mailtank',
        'host' => 'api.mailtank.ru',
        'token' => '',                          // API access key
        'templatesPath' => '@app/views/mail',   // Path or alias to folder with mailtank templates without end slash 
        'templatePrefix' => 'testproject.com',  // Template prefix, unique for project
        'excludeTemplates' => [                 // Exclude templates like 'base'
            'baseMail',
            'subfolder/otherExcludeMail',
        ],
    ],

Then use:

Yii::$app->mailtank->send