Yii Mailer Library - Symfony Mailer Extension

3.0.1 2024-05-24 11:18 UTC



Yii Mailer Library - Symfony Mailer Extension

Latest Stable Version Total Downloads Build status Code Coverage Mutation testing badge static analysis type-coverage

This package is an adapter for yiisoft/mailer relying on symfony/mailer.


  • PHP 8.1 or higher.


The package could be installed with Composer:

composer require yiisoft/mailer-symfony

General usage

Creating a mailer:

use Yiisoft\Mailer\MessageBodyRenderer;
use Yiisoft\Mailer\MessageBodyTemplate;
use Yiisoft\Mailer\MessageFactory;
use Yiisoft\Mailer\Symfony\Mailer;
use Yiisoft\Mailer\Symfony\Message;

 * @var \Psr\EventDispatcher\EventDispatcherInterface $dispatcher
 * @var \Symfony\Component\Mailer\Transport\TransportInterface $transport
 * @var \Yiisoft\View\View $view

$template = new MessageBodyTemplate('/path/to/directory/of/view-files');

$mailer = new Mailer(
    new MessageFactory(Message::class),
    new MessageBodyRenderer($view, $template),

Sending a mail message:

$message = $mailer
    ->withSubject('Message subject')
    ->withTextBody('Plain text content')
    ->withHtmlBody('<b>HTML content</b>')
// Or several

Additional methods of the Yiisoft\Mailer\Symfony\Mailer:

  • withEncryptor() - Returns a new instance with the specified encryptor instance.
  • withSigner() - Returns a new instance with the specified signer instance.

For more information about signing and encrypting messages, see the corresponding section of the documentation.

The Yiisoft\Mailer\Symfony\Message class provides a single getSymfonyEmail() method that returns a Symfony Email instance.

For use in the Yii framework, see the configuration files:


If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.


The Yii Mailer Library - Symfony Mailer Extension is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack