Yii2 mail queue component for yii2-swiftmailer.

Installs: 4 246

Dependents: 0

Suggesters: 0

Security: 0

Stars: 15

Watchers: 3

Forks: 4

Open Issues: 3


1.1.5 2019-08-12 06:00 UTC

This package is auto-updated.

Last update: 2024-04-05 21:53:19 UTC


Yii2 mail queue component for yii2-swiftmailer.

Latest Stable Version


Since 1.1.1 requires PHP >= 7.0


The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist tigrov/yii2-mailqueue "~1.1.1"

or add

"tigrov/yii2-mailqueue": "~1.1.1"

to the require section of your composer.json file.


Once the extension is installed, add following code to your application configuration:

return [
    // ...
    'components' => [
        'mailer' => [
            'class' => 'tigrov\mailqueue\Mailer',
            'table' => '{{%mail_queue}}',
            'maxAttempts' => 5,
            'attemptIntervals' => [0, 'PT10M', 'PT1H', 'PT6H'],
            'removeFailed' => true,
            'maxPerPeriod' => 10,
            'periodSeconds' => 1,
    // ...

Following properties are available for customizing the mail queue behavior.

  • table name of the database table to store emails added to the queue;
  • maxAttempts maximum number of sending attempts per email;
  • attemptIntervals seconds or interval specifications to delay between attempts to send a mail message, see http://php.net/manual/en/dateinterval.construct.php;
  • removeFailed indicator to remove mail messages which were not sent in maxAttempts;
  • maxPerPeriod number of mail messages which could be sent per periodSeconds;
  • periodSeconds period in seconds which indicate the time interval for maxPerPeriod option.

Updating database schema

Run yii migrate command in command line:

php yii migrate/up --migrationPath=@vendor/tigrov/yii2-mailqueue/src/migrations/

Sending the mail queue

To sending mails from the queue call Yii::$app->mailer->sending() or run the console command yii mailqueue which can be triggered by a CRON job:

* * * * * php /var/www/vhosts/domain.com/yii mailqueue/sending

After the mail message successfully sent it will be deleted from the queue.


You can then send a mail to the queue as follows:

     ->delay('PT3M') // seconds or an interval specification to delay of sending the mail message, see http://php.net/manual/en/dateinterval.construct.php
     ->unique('unique key') // a unique key for the mail message, new message with the same key will replace the old one

You can still send mails directly with yii2-swiftmailer: