README

This package is deprecated in favor of Symfony Mailer Extension.

See details in article The end of Swiftmailer by Fabien Potencier.

❌

Yii Mailer Library - Swift Mailer Extension

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

Installation

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),
    $dispatcher,
    $transport,
    $plugins, // By default, an empty array
);

Sending a mail message:

$message = $mailer
    ->compose()
    ->withFrom('from@domain.com')
    ->withTo('to@domain.com')
    ->withSubject('Message subject')
    ->withTextBody('Plain text content')
    ->withHtmlBody('<b>HTML content</b>')
;
$mailer->send($message);
// Or several
$mailer->sendMultiple([$message]);

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:

• config/common.php
• config/params.php

See Yii guide to mailing for more info.

Testing

Unit testing

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

Mutation testing

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

./vendor/bin/roave-infection-static-analysis-plugin

Static analysis

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

./vendor/bin/psalm

License

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

Follow updates