yiisoft/yii-swiftmailer

This package is abandoned and no longer maintained. The author suggests using the yiisoft/mailer package instead.

Yii Mailer Library - Swift Mailer Extension

3.0.1 2021-08-30 18:26 UTC

This package is auto-updated.

Last update: 2022-02-10 13:36:45 UTC


README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667 68747470733a2f2f73776966746d61696c65722e73796d666f6e792e636f6d2f696d616765732f6c6f676f2e706e67

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.

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:

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

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack