README

Yii2 mailer component with pluggable multiple mail providers including Sparkpost, SMTP, SES.

Installation

composer require package-of-yii/mailer-gateways

Then add the bridge for the provider(s) you actually use:

Configuration

'components' => [
    'mailer' => [
        'class' => POYii\Mail\Mailer::class,
        'providerConfig' => [
            'provider' => 'sparkpost',
            'api_key' => getenv('SPARKPOST_API_KEY'),
        ],
    ],
],

// SMTP
'providerConfig' => [
    'provider' => 'smtp',
    'host' => 'smtp.example.com',
    'port' => 587,
    'username' => '...',
    'password' => '...',
],

// Amazon SES (mode: api [default] | https | smtp)
'providerConfig' => [
    'provider' => 'ses',
    'access_key' => 'AKIA...',
    'secret_key' => '...',
    'region' => 'us-east-1',
],

// Mailgun (mode: api [default] | https | smtp)
'providerConfig' => [
    'provider' => 'mailgun',
    'key' => '...',
    'domain' => 'mail.example.com',
    'region' => 'eu',
],

// SparkPost (mode: api [default] | smtp)
'providerConfig' => [
    'provider' => 'sparkpost',
    'api_key' => '...',
    'region' => 'eu',
],

// Disable sending
'providerConfig' => ['provider' => 'null'],

// In-memory, for tests
'providerConfig' => ['provider' => 'array'],

region is optional for ses/mailgun/sparkpost. port is optional for smtp.

Usage

Yii::$app->mailer->compose('contact/html', ['user' => $user])
    ->setFrom('postmaster@example.com')
    ->setTo($user->email)
    ->setSubject('Hello')
    ->send();

Extending with a custom provider

$factory = new Pralhadstha\Mail\MailerFactory();
$factory->registerProvider('postmark', new App\Mail\PostmarkProvider());

'components' => [
    'mailer' => [
        'class' => POYii\Mail\Mailer::class,
        'providerConfig' => ['provider' => 'postmark', 'api_key' => '...'],
        'factory' => $factory,
    ],
],

Development

composer install
composer test
composer stan
composer csfix && composer cs