Yii Mailer Library

The package provides the content composition functionality, and a basic interface for sending emails. Actual mail sending is provided by separate interchangeable packages.

Out of the box the package profiles a file mailer that, instead of actually sending an email, writes its contents into a file. There are also Swift Mailer and Symfony Mailer based official drivers available as a separate packages that actually can send emails.

Requirements

PHP 8.0 or higher.

Installation

The package could be installed with Composer:

composer require yiisoft/mailer

General usage

The following code can be used to send an email:

/**
 * @var \Yiisoft\Mailer\MailerInterface $mailer
 */

$message = $mailer
    ->compose()
    ->withFrom('[email protected]')
    ->withTo('[email protected]')
    ->withSubject('Message subject')
    ->withTextBody('Plain text content')
    ->withHtmlBody('<b>HTML content</b>');
    
$mailer->send($message);

Localize view file

You can set a specific locale that will be used to localize view files with withLocale() method:

/**
 * @var \Yiisoft\Mailer\MailerInterface $mailer
 */

$message = $mailer
    ->withLocale('de_DE')
    ->compose('html-view')
    ->withFrom('[email protected]')
    ->withTo('[email protected]')
    ->withSubject('Message subject');
    
$mailer->send($message);