yii2-swiftmailer/extensions/swiftmailer/README.md

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:

return [
	//....
	'components' => [
		'mail' => [
			'class' => 'yii\swiftmailer\Mailer',
		],
	],
];

Extension also includes FileMailer that saves mails as files under runtime directory. It can be useful during development. To use it add the following code in your application configuration:

return [
	//....
	'components' => [
		'mail' => [
			'class' => 'yii\swiftmailer\FileMailer',
		],
	],
];

You can then send an email as follows:

Yii::$app->mail->compose('contact/html')
     ->from('from@domain.com')
     ->to($form->email)
     ->subject($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.

Either run

php composer.phar require yiisoft/yii2-swiftmailer "*"

or add

"yiisoft/yii2-swiftmailer": "*"

to the require section of your composer.json.