frank/symfonymailer-for-yii2

Symfonymailer for Yii2

dev-master / 2.0.x-dev 2022-08-15 13:40 UTC

Requires

• php: >=7.3.19
• symfony/mailer: >=5.4.0
• yiisoft/yii2: >=2.0.4

Requires (Dev)

• phpunit/phpunit: 9.5.10

BSD-3-Clause

README

Version: 1.0.1

The preferred way to install this extension is through composer.

Either run:

php composer.phar require --prefer-dist yiisoft/yii2-symfonymailer

or add:

"frank1fr/yii2-symfonymailer": "~1.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

return [
    //....
    'components' => [
        'mailer' => [
            'class' => \yii\symfonymailer\Mailer::class,            
            'transport' => [
                'dsn' => 'smtp://user:[e-mail]:25',
            ],
        ],
    ],
];

You can then send an email as follows:

Yii::$app->mailer->compose('contact/html')
     ->setFrom('[e-mail]')
     ->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:

   '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:

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