README

Yii Mailer - Symfony Mailer Extension

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

Requirements

• PHP 8.1 or higher.

Installation

The package could be installed with Composer:

composer require yiisoft/mailer-symfony

General usage

Creating a mailer:

use Yiisoft\Mailer\Symfony\Mailer;

/**
 * @var \Symfony\Component\Mailer\Transport\TransportInterface $transport
 */

$mailer = new \Yiisoft\Mailer\Symfony\Mailer(
    $transport,
);

Sending a mail message:

$message = (new \Yiisoft\Mailer\Message())
    ->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\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.

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

• config/di.php
• config/params.php

Documentation

• Yii guide to mailing
• Symfony Mailer documentation
• Internals

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.

License

The Yii Mailer - 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

Follow updates