Files
yii2/extensions/yii/swiftmailer/README.md
Alexander Makarov dc45de127c Added --prefer-dist to all docs
1. It results in much smaller download and takes less disk space (25MB instead of 180MB for yii-basic + dependencies).
2. It requires less utilities to be installed (no VCS binaries required).
3. It takes less time to install dependencies.
2014-01-07 01:27:16 +04:00

50 lines
941 B
Markdown

SwiftMailer Extension for Yii 2
===============================
This extension provides a `SwiftMailer` mail solution for Yii 2.
To use this extension, simply add the following code in your application configuration:
```php
return [
//....
'components' => [
'mail' => [
'class' => 'yii\swiftmailer\Mailer',
],
],
];
```
You can then send an email as follows:
```php
Yii::$app->mail->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.
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist yiisoft/yii2-swiftmailer "*"
```
or add
```json
"yiisoft/yii2-swiftmailer": "*"
```
to the require section of your composer.json.