yiisoft / mailer-symfony
Yii Mailer Library - Symfony Mailer Extension
Fund package maintenance!
Opencollective
yiisoft
Installs: 55 917
Dependents: 7
Suggesters: 1
Security: 0
Stars: 11
Watchers: 17
Forks: 5
Open Issues: 1
Requires
- php: ^8.0
- psr/event-dispatcher: ^1.0
- symfony/mailer: ^5.3|^6.0|^7.0
- symfony/mime: ^5.4|^6.2|^7.0
- yiisoft/mailer: ^5.0
Requires (Dev)
- maglnet/composer-require-checker: ^4.2
- phpunit/phpunit: ^9.5
- rector/rector: ^1.0.0
- roave/infection-static-analysis-plugin: ^1.25
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.30|^5.4
- yiisoft/aliases: ^3.0
- yiisoft/di: ^1.2
- yiisoft/files: ^2.0
- yiisoft/psr-dummy-provider: ^1.0
- yiisoft/test-support: ^3.0
- yiisoft/view: ^8.0
This package is auto-updated.
Last update: 2024-10-03 10:11:59 UTC
README
Yii Mailer Library - 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\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), $dispatcher, $transport, );
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\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:
Documentation
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 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.