Skip to content
Switch branches/tags

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Yii Mailer Library - Swift Mailer Extension

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

This package is a yiisoft/mailer library implementation that provides a Swift Mailer mail solution.


The package could be installed with composer:

composer require yiisoft/mailer-swiftmailer --prefer-dist

General usage

Creating a mailer:

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

 * @var \Psr\EventDispatcher\EventDispatcherInterface $dispatcher
 * @var \Swift_Events_EventListener[] $plugins
 * @var \Swift_Transport $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),
    $plugins, // By default, an empty array

Sending a mail message:

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

Additional methods of the Yiisoft\Mailer\SwiftMailer\Message:

  • getSwiftMessage() - Returns a Swift message instance.
  • getReadReceiptTo() - Returns the addresses to which a read-receipt will be sent.
  • withReadReceiptTo() - Returns a new instance with the specified ask for a delivery receipt from the recipient to be sent to address.
  • withAttachedSigners() - Returns a new instance with the specified attached signers.

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

See Yii guide to mailing for more info.


Unit testing

The package is tested with PHPUnit. To run tests:


Mutation testing

The package tests are checked with Infection mutation framework with Infection Static Analysis Plugin. To run it:


Static analysis

The code is statically analyzed with Psalm. To run static analysis:



The Yii Framework Swift 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