Queue mailer decorator for Yii2 framework ¶

1. Installation
2. Usage
3. Licence
4. Links

Send your emails in the background using Yii2 queues.

Installation ¶

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist yarcode/yii2-queue-mailer

or add

"yarcode/yii2-queue-mailer": "*"

Usage ¶

Configure queue component of your application. You can find the details here: https://www.yiiframework.com/extension/yiisoft/yii2-queue

Configure YarCode\Yii2\QueueMailer\Mailer as your primary mailer.

  'mailer' => [
      'class' => \YarCode\Yii2\QueueMailer\Mailer::class,
      'syncMailer' => [
          'class' => \yii\swiftmailer\Mailer::class,
          'useFileTransport' => true,
      ],
  ],

Now you can send your emails as usual.

$message = \Yii::$app->mailer->compose()
  ->setSubject('test subject')
  ->setFrom('test@example.org')
  ->setHtmlBody('test body')
  ->setTo('user@example.org');

\Yii::$app->mailer->send($message);

You can also get a background job ID of the last send() or sendMultiple() call. $jobId = \Yii::$app->mailer->getLastJobId();

Licence ¶

MIT

Links ¶

• GitHub repository
• Composer package