https://github.com/yiisoft/mailer-view
Yii Mailer message body rendering extension
https://github.com/yiisoft/mailer-view
hacktoberfest mailer yii3
Last synced: 7 months ago
JSON representation
Yii Mailer message body rendering extension
- Host: GitHub
- URL: https://github.com/yiisoft/mailer-view
- Owner: yiisoft
- License: bsd-3-clause
- Archived: true
- Created: 2024-10-07T13:51:56.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-10-18T07:28:22.000Z (12 months ago)
- Last Synced: 2025-02-20T14:21:34.986Z (8 months ago)
- Topics: hacktoberfest, mailer, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 31.3 KB
- Stars: 5
- Watchers: 14
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Mailer View
[](https://packagist.org/packages/yiisoft/mailer-view)
[](https://packagist.org/packages/yiisoft/mailer-view)
[](https://github.com/yiisoft/mailer-view/actions/workflows/build.yml)
[](https://codecov.io/gh/yiisoft/mailer-view)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/mailer-view/master)
[](https://github.com/yiisoft/mailer-view/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/mailer-view)
[](https://shepherd.dev/github/yiisoft/mailer-view)
This [Yii Mailer](https://github.com/yiisoft/mailer) extension provides classes for composing message body via view
rendering:
- `MessageBodyRenderer` - a view renderer used to compose message body.
- `ViewMailer` - a mailer decorator with `compose()` method.
## Requirements
- PHP 8.1 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/mailer-view
```
## General usage
### Message body renderer
```php
use Yiisoft\Mailer\View\MessageBodyRenderer;
use Yiisoft\Mailer\View\MessageBodyTemplate;
use Yiisoft\View\View;
$renderer = new MessageBodyRenderer(
new View(),
new MessageBodyTemplate(
__DIR__ . '/views',
'html-layout',
),
);
// HTML body
$htmlBody = $renderer->renderHtml(
view: 'html-content',
viewParameters: ['count' => 42],
layoutParameters: ['header' => 'Hello!'],
);
// Text body
$textBody = $renderer->renderText(
view: 'html-content',
viewParameters: ['count' => 42],
layoutParameters: ['header' => 'Hello!'],
);
// Add body to message
$message = $renderer->addBodyToMessage(
message: new Message(),
htmlView: 'html-content',
viewParameters: ['count' => 42],
layoutParameters: ['header' => 'Hello!'],
);
```
If needed, you can pass `textView` parameter with the name of the text view.
### Mailer decorator
```php
/**
* @var \Yiisoft\Mailer\MailerInterface $mailer
* @var Yiisoft\Mailer\View\MessageBodyRenderer $messageBodyRenderer
*/
$viewMailer = new ViewMailer($mailer, $messageBodyRenderer);
// Create message
$message = $viewMailer->compose(
htmlView: 'html-content',
viewParameters: ['count' => 42],
layoutParameters: ['header' => 'Hello!'],
);
// Send message
$viewMailer->send($message);
```
If needed, you can pass `textView` parameter with the name of the text view.
## Documentation
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place
for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii Mailer View is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)