yarcode/yii2-queue-mailer

Queue mailer decorator for Yii2 framework

Installs: 15 262

Dependents: 0

Suggesters: 0

Security: 0

Stars: 10

Watchers: 3

Forks: 3

Open Issues: 2

Type:yii2-extension

1.0.3 2018-06-13 05:24 UTC

This package is not auto-updated.

Last update: 2024-10-26 08:23:29 UTC


README

Send your emails in the background using Yii2 queues.

Build Status Latest Stable Version Total Downloads License

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