# 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.

# Class Reference

Class | Description
--- | ---
yii\swiftmailer\Logger | Logger is a SwiftMailer plugin, which allows passing of the SwiftMailer internal logs to the Yii logging mechanism. Each native SwiftMailer log message will be converted into Yii 'info' log entry.
yii\swiftmailer\Mailer | Mailer implements a mailer based on SwiftMailer.
yii\swiftmailer\Message | Message implements a message class based on SwiftMailer.