yiisoft / yii2-swiftmailer
The SwiftMailer integration for the Yii framework
Fund package maintenance!
Open Collective
yiisoft
Tidelift
Installs: 17 625 909
Dependents: 763
Suggesters: 2
Security: 0
Stars: 116
Watchers: 27
Forks: 74
Open Issues: 3
Type:yii2-extension
Requires
- swiftmailer/swiftmailer: ~6.0
- yiisoft/yii2: >=2.0.4
Requires (Dev)
- cweagans/composer-patches: ^1.7
- phpunit/phpunit: 4.8.34
README
SwiftMailer Extension for Yii 2
This extension provides a SwiftMailer mail solution for Yii framework 2.0.
For license information check the LICENSE-file.
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist yiisoft/yii2-swiftmailer
or add
"yiisoft/yii2-swiftmailer": "~2.1.0"
to the require section of your composer.json.
Note: Version 2.1 of this extensions uses Swiftmailer 6, which requires PHP 7. If you are using PHP 5, you have to use version 2.0 of this extension, which uses Swiftmailer 5, which is compatible with PHP 5.4 and higher. Use the following version constraint in that case:
"yiisoft/yii2-swiftmailer": "~2.0.0"
Usage
To use this extension, simply add the following code in your application configuration:
return [ //.... 'components' => [ 'mailer' => [ 'class' => 'yii\swiftmailer\Mailer', ], ], ];
You can then send an email as follows:
Yii::$app->mailer->compose('contact/html') ->setFrom('from@domain.com') ->setTo($form->email) ->setSubject($form->subject) ->send();
For further instructions refer to the related section in the Yii Definitive Guide.