Skip to content

Yii 2 swiftmailer extension.

License

Notifications You must be signed in to change notification settings

yiisoft/yii2-swiftmailer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

eb11929 · Feb 13, 2025
Nov 29, 2023
Dec 1, 2023
Oct 31, 2020
Sep 29, 2015
Mar 21, 2016
May 3, 2015
Dec 30, 2021
Apr 26, 2018
May 3, 2015
Dec 3, 2023
Aug 4, 2017
Feb 13, 2025
Jan 31, 2018

Repository files navigation

SwiftMailer Extension for Yii 2


This extension provides a SwiftMailer mail solution for Yii framework 2.0.

For license information check the LICENSE-file.

Latest Stable Version Total Downloads Build Status

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.