https://github.com/ttskch/twiggedswiftmessagebuilder
Twig templated Swift_Message builder service.
https://github.com/ttskch/twiggedswiftmessagebuilder
Last synced: 10 days ago
JSON representation
Twig templated Swift_Message builder service.
- Host: GitHub
- URL: https://github.com/ttskch/twiggedswiftmessagebuilder
- Owner: ttskch
- License: mit
- Created: 2014-11-15T00:13:25.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2016-09-23T09:03:12.000Z (over 9 years ago)
- Last Synced: 2025-09-22T15:52:35.926Z (5 months ago)
- Language: PHP
- Size: 84 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TwiggedSwiftMessageBuilder
[](https://travis-ci.org/ttskch/TwiggedSwiftMessageBuilder)
[](https://packagist.org/packages/ttskch/twigged-swiftmessage-builder)
[](https://packagist.org/packages/ttskch/twigged-swiftmessage-builder)
`TwiggedSwiftMessageBuilder` class allows you following things:
* to create Twig templated Swift_Message
* to create inline styled html email from unstyled html and css strings
* to embed some image files into message body
## Requirements
* PHP 5.3+
## Getting started
First add this dependency into your `composer.json`:
```json
{
"require": {
"ttskch/twigged-swiftmessage-builder": "~2.0"
}
}
```
Then you can send Twig templated email as below:
```twig
{# email.txt.twig #}
{% block from %}no-reply@example.com{% endblock %}
{% block from_name %}[Example]{% endblock %}
{% block subject %}Welcome to [Example]!{% endblock %}
{% block body %}
Hello [Example] World!
{% endblock %}
```
```php
// in your application.
$builder = new \Ttskch\TwiggedSwiftMessageBuilder\TwiggedSwiftMessageBuilder($tiwg); // $twig is an instance of \Twig_Environment class.
$message = $builder->buildMessage('email.txt.twig');
$message->setTo('hoge@example.com');
$mailer->send($message); // $mailer is an instance of \Swift_Mailer class.
```
In Twig template you can define many things by using `{% block [field-name] %}{% endblock %}`.
These fields can be defined.
* from
* from_name
* to
* cc
* bcc
* reply_to
* subject
* body
## Use variables in Twig template
Offcourse you can pass variables and use them in Twig template as below:
```twig
{# email.txt.twig #}
{% block subject %}Welcome to {{ site_title }}!{% endblock %}
```
```php
// in your application.
$builder = new \Ttskch\TwiggedSwiftMessageBuilder\TwiggedSwiftMessageBuilder($tiwg);
$message = $builder->buildMessage('email.txt.twig', array(
'site_title' => 'FooBar Service',
));
$message->setTo('hoge@example.com');
$mailer->send($message);
```
## Use inline-styled html email
You can make inline-styled html from unstyled html and css strings.
To allow recipients of your html email to receive it with Gmail, you will have to make inline-styled html body.
```php
// in your application.
$builder = new \Ttskch\TwiggedSwiftMessageBuilder\TwiggedSwiftMessageBuilder($tiwg);
$message = $builder->buildMessage('email.html.twig');
$style = file_get_contents('/path/to/style.css');
$message = $builder->setInlineStyle($message, $style);
$mailer->send($message);
```
> **Note**
>
> This functionality is using `mb_convert_encoding()` with `'auto'` internally. So if you use this you **must** set `mbstring.language` in php.ini or call `mb_language('your_language')` on ahead.
>
> **注意**
>
> この機能は内部的に `mb_convert_encoding()` に `'auto'` を渡して実行します。なので、php.ini で `mbstring.language` を設定するか、`mb_language('Japanese')` を事前に実行しておく必要があります。
## Embed some image files into message body
You can embed images into message body as below:
```twig
{# email.html.twig #}
{% block body %}
%20}})
{% endblock %}
```
```php
// in your application.
$builder = new \Ttskch\TwiggedSwiftMessageBuilder\TwiggedSwiftMessageBuilder($tiwg);
$message = $builder->buildMessage('email.html.twig', array(
'image_path' => '/path/to/image/file',
));
// you can get renderable html with base64 encoded images. (In case you want to print preview.)
$renderableHtml = $builder->renderBody($message);
// you must finalize embedding before send message.
$message = $builder->finalizeEmbedding($message);
$mailer->send($message);
```
## Enjoy!
See also [functional tests](tests/FunctionalTest.php) to understand basic usages.