Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/izumi-kun/yii2-spoolmailer
Implements email queue using SwiftMailer spool transport and yii2-swiftmailer extension
https://github.com/izumi-kun/yii2-spoolmailer
email mailer queue swiftmailer swiftmailer-spool yii2
Last synced: 3 months ago
JSON representation
Implements email queue using SwiftMailer spool transport and yii2-swiftmailer extension
- Host: GitHub
- URL: https://github.com/izumi-kun/yii2-spoolmailer
- Owner: Izumi-kun
- License: bsd-3-clause
- Created: 2017-03-17T11:24:48.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-12-14T16:23:40.000Z (about 6 years ago)
- Last Synced: 2024-09-19T23:29:24.805Z (4 months ago)
- Topics: email, mailer, queue, swiftmailer, swiftmailer-spool, yii2
- Language: PHP
- Homepage:
- Size: 38.1 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
SwiftMailer Extension for Yii 2 with Spooling
=============================================
Implements email queue using [SwiftMailer](http://swiftmailer.org/) spool transport and [yii2-swiftmailer](https://github.com/yiisoft/yii2-swiftmailer) extension.
It supported queues based on built-in SwiftMailer spools or [Yii2 Queue Extension](https://github.com/yiisoft/yii2-queue).
[](https://packagist.org/packages/izumi-kun/yii2-spoolmailer)
[](https://packagist.org/packages/izumi-kun/yii2-spoolmailer)
[](https://travis-ci.org/Izumi-kun/yii2-spoolmailer)
[](https://scrutinizer-ci.com/g/Izumi-kun/yii2-spoolmailer/?branch=master)
[](https://scrutinizer-ci.com/g/Izumi-kun/yii2-spoolmailer/?branch=master)
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist izumi-kun/yii2-spoolmailer
```
or add
```
"izumi-kun/yii2-spoolmailer": "~1.0.0"
```
to the require section of your composer.json.
Basic Usage
-----------
This way uses built-in SwiftMailer spools: **FileSpool** (default) or **MemorySpool**.
Add the following code in your application configuration (both web and console):
```php
return [
//....
'components' => [
//....
'mailer' => [
'class' => izumi\spoolmailer\Mailer::class,
],
],
];
```
Add the following code in your console configuration:
```php
return [
//....
'controllerMap' => [
'mail' => izumi\spoolmailer\MailController::class,
],
];
```
You can then add an email in queue as follows:
```php
Yii::$app->mailer->compose('contact/html')
->setFrom('[email protected]')
->setTo($form->email)
->setSubject($form->subject)
->queue();
```
Process email queue by follow console command:
```
./yii mail/flush
```
CRON job:
```
* * * * * php /var/www/yii-app/yii mail/flush >/dev/null 2>&1
```
Advanced Usage
--------------
This way requires [Yii2 Queue Extension](https://github.com/yiisoft/yii2-queue) in your application.
Add the following code in your application configuration (both web and console):
```php
return [
//....
'components' => [
//....
'mailer' => [
'class' => izumi\spoolmailer\Mailer::class,
'spoolMailer' => [
'class' => izumi\spoolmailer\spools\QueueSpool::class,
'queue' => 'queue', // the application component ID of the queue object
],
],
],
];
```
For more details see the [Yii2 Queue Guide](https://github.com/yiisoft/yii2-queue/blob/master/docs/guide/README.md).
License
-------
BSD-3-Clause