yiisoft/yii2-symfonymailer The SymfonyMailer integration for the Yii framework

yii_logo.svg

Yii Mailer Library - Symfony Mailer Extension

  1. Installation
  2. Usage
  3. Migrating from yiisoft/yii2-swiftmailer

This extension provides a Symfony Mailer 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-symfonymailer

or add

"yiisoft/yii2-symfonymailer": "~2.0.0"

to the require section of your composer.json.

Usage

To use this extension, simply add the following code in your application configuration:

return [
    //....
    'components' => [
        'mailer' => [
            'class' => \yii\symfonymailer\Mailer::class,            
            'transport' => [
                'scheme' => 'smtps',
                'host' => '',
                'username' => '',
                'password' => '',
                'port' => 465,
                'dsn' => 'native://default',
            ],
            'viewPath' => '@common/mail',
            // send all mails to a file by default. You have to set
			// 'useFileTransport' to false and configure transport
			// for the mailer to send real emails.
			'useFileTransport' => false,
        ],
    ],
];

or `php return [

//....
'components' => [
    'mailer' => [
        'class' => \yii\symfonymailer\Mailer::class,            
        'transport' => [
            'dsn' => 'smtp://user:pass@smtp.example.com:25',
        ],
    ],
],

]; `

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();

Migrating from yiisoft/yii2-swiftmailer

Follow these steps to migrate from the deprecated yiisoft/yii2-swiftmailer to this extension:

  1. Swiftmailer default transport was the SendmailTransport, while this extension will default to a NullTransport (sends no mail). You can use the swiftmailer default by defining in application config: `php 'mailer' => [

    'class' => yii\symfonymailer\Mailer::class,
    'transport' => [
        'dsn' => 'sendmail://default',
    ],
    

    ], `

  2. Codeceptions TestMailer specifies swiftmailer\Message as a default class in https://github.com/Codeception/module-yii2/blob/master/src/Codeception/Lib/Connector/Yii2/TestMailer.php#L8. This can also be changed by defining in test config: `php 'mailer' => [

    'class' => yii\symfonymailer\Mailer::class,
    'messageClass' => \yii\symfonymailer\Message::class,
    

    ], `

0 0
1 follower
139 934 downloads
Yii Version: 2.0
License: BSD-3-Clause
Category: Mail
Tags:
Developed by: The Yii Team
Created on: Sep 19, 2022
Last updated: (not set)
API Documentation

Packagist Profile
Github Repository