2017 © Pedro Peláez
 

yii2-extension yii2-mailqueue

The simple and powerful Mail Queue for the Yii2 framework

image

yiicod/yii2-mailqueue

The simple and powerful Mail Queue for the Yii2 framework

  • Sunday, February 18, 2018
  • by lexxorlov
  • Repository
  • 4 Watchers
  • 7 Stars
  • 715 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 7 Versions
  • 25 % Grown

The README.md

Yii Mail Queue

Latest Stable Version Total Downloads Scrutinizer Code QualityCode Climate, (*1)

Mail queue for emails. You don't need think how many emails will be send, because when you install this extension you can setting this. You will have table, where you can see emails status., (*2)

The preferred way to install this extension is through composer., (*3)

Either run, (*4)

php composer.phar require --prefer-dist yiicod/yii2-mailqueue "*"

or add, (*5)

"yiicod/yii2-mailqueue": "*"

to the require section of your composer.json., (*6)

run, (*7)

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

Please note that messages are wrapped with Yii::t() to support message translations, you should define default message source for them if you don't use i18n., (*8)

'i18n' => [
    'translations' => [
        '*' => [
            'class' => 'yii\i18n\PhpMessageSource'
        ],
    ],
],

Config

Use pm2(http://pm2.keymetrics.io/) as daemons manager., (*9)

'components' => [
    'mailqueue' => [
        'class' => 'yiicod\mailqueue\WorkerCommand',
    ],
]
...
'bootstrap' => array('mailqueue')

Full config you can find in the yiicod\mailqueue\config., (*10)

Console command

'commandMap' => [
    'mail-queue' => [
        'class' => 'yiicod\mailqueue\commands\MailQueueCommand',
    ],
],
OR use pm2(http://pm2.keymetrics.io/). This variant more preferable.
'commandMap' => [
    'mail-queue' => [
        'class' => 'yiicod\mailqueue\commands\WorkerCommand',
    ],
],
pm2 config:
    {
      "apps": [
        {
          "name": "job-queue",
          "script": "yii",
          "args": [
            "mailqueue/work"
          ],
          "exec_interpreter": "php",
          "exec_mode": "fork_mode",
          "max_memory_restart": "1G",
          "watch": false,
          "merge_logs": true,
          "out_file": "runtime/logs/job_queue.log",
          "error_file": "runtime/logs/job_queue.log"
        }
      ]
    }
Run PM2 daemons
pm2 start daemons-app.json

Migration usage

Migration command or use manual(http://www.yiiframework.com/doc-2.0/guide-db-migrations.html) for configuration:, (*11)

   yii migrate --migrationPath=@yiicod/mailqueue/migrations

Push in queue

/**
 * Add mail from queue
 * @param string $to Email to
 * @param string $subject Email subject
 * @param string $body email, html
 * @param string|Array $from From email
 * @param string $attachs Attach for email array('path' => 'file path', 'name' => 'file bname')
 * @param Array $additionalFields Any additional fields
 */
Yii::app()->mailQueue->push($to, $subject, $body, $from = '', array $attachs = [], $additionalFields = []);

or, (*12)

/**
 * Push mass
 * array(
 *    array(
 *      'field name to' => '',
 *      'field name subject' => '',
 *      'field name body' => '',
 *      'field name priority' => '',
 *      'field name from' => '',
 *      'field name attachs' => '',
 *    )
 * )
 * @param Array $data
 * @return int Return int
 */
Yii::app()->mailQueue->pushMass($data)

The Versions

18/02 2018

dev-master

9999999-dev

The simple and powerful Mail Queue for the Yii2 framework

  Sources   Download

MIT New BSD License

The Requires

 

The Development Requires

18/02 2018

1.1.1

1.1.1.0

The simple and powerful Mail Queue for the Yii2 framework

  Sources   Download

MIT

The Requires

 

The Development Requires

22/07 2017

1.1.0

1.1.0.0

The simple and powerful Mail Queue for the Yii2 framework

  Sources   Download

New BSD License

The Requires

 

16/03 2016

1.0.3

1.0.3.0

The simple and powerful Mail Queue for the Yii2 framework

  Sources   Download

New BSD License

The Requires

 

13/12 2015

1.0.2

1.0.2.0

The simple and powerful Mail Queue for the Yii2 framework

  Sources   Download

New BSD License

The Requires

 

01/11 2015

1.0.1

1.0.1.0

The simple and powerful Mail Queue for the Yii2 framework

  Sources   Download

New BSD License

The Requires

 

26/07 2015

1.0.0

1.0.0.0

  Sources   Download

New BSD License

The Requires