Mail Renderer Bundle
Symfony bundle that collects some libraries together to make sending emails easier:, (*1)
- Renders twig template to get subject and content of an email
- Converts HTML content to plain text if it's not available in template
- Sets default From email and name to message
- Gets CSS for mail messages using Assetic, if configured
- Inlines CSS inside HTML
style attributes and/or adds <styles> tag
- Sends message using swift mailer
Installation
Add via composer:, (*2)
composer require maba/mail-renderer-bundle jimbojsb/emogrify:@dev
Register bundle:, (*3)
new Maba\Bundle\MailRendererBundle\MabaMailRendererBundle(),
Configure in config.yml:, (*4)
maba_mail_renderer:
css_assets:
inline: mail
imports: mail_imports
from:
email: info@example.com
name: My Awesome Company
assetic:
assets:
mail:
inputs:
- @bootstrap_css
- @ApplicationBundle/Resources/less/styles.less
mail_imports:
inputs:
- %kernel.root_dir%/Resources/public/css/mail-imports.css
css_assets node is optional, as is usage of Assetic., (*5)
Usage
Code:, (*6)
/** @var FormattedMessageMailer $mailer */
$mailer = $this->get('maba_mail_renderer.formatted_message_mailer');
$mailer->sendMessage('customer@example.com', 'ApplicationBundle:Email:welcome.html.twig', array(
'username' => 'customer123',
'activationLink' => 'http://www.example.com/activate/ABC123',
));
Twig template:, (*7)
{# ApplicationBundle:Email:welcome.html.twig #}
{% block subject %}Hello {{ username }}, welcome to example.com!{% endblock %}
{% block body_html %}
<div class="content">
You've registered on example.com. Here you can make lots of stuff:
<ul>
<li>Stuff</li>
<li>More stuff</li>
</ul>
</div>
<div class="important">
To activate your account <a class="btn btn-primary" href="{{ activationLink }}">click here</a>
</div>
<div class="footer">See ya!</div>
{% endblock %}
That's it!, (*8)
All CSS rules assigned to classes will be inlined into HTML as style attributes., (*9)
Extended usage
Templates
Only these blocks are parsed from template: subject, body_html and body_text.
subject and at least one of other two are required. Any other blocks or content in template is ignored., (*10)
If body_text is provided, it will be used as plain text version of mailer message., (*11)
Additionally toEmail variable is passed to the twig template, which equals to the given recipient., (*12)
I'd suggest to use single layout twig file, if there's defined structure in your mails. For example:, (*13)
{# :Email:layout.html.twig #}
{% block body_html %}
{% block content %}{% endblock %}
<div class="footer">See ya!</div>
<a href="{{ get_unsubscribe_link(toEmail) }}">Unsubscribe</a>
{% endblock %}
{# ApplicationBundle:Email:welcome.html.twig #}
{% extends ':Email:layout.html.twig' %}
{% block subject %}...{% endblock %}
{% block content %}
...
{% endblock %}
Styles
inline and imports values in css_assets configuration node take Assetic asset name, which you should configure
using Assetic configuration., (*14)
inline is used when applying CSS rules to message HTML result - style attributes are added to HTML nodes, which
would trigger appropriate CSS rules. This is needed as some email readers support neither <styles> nor <link>
(for example GMail)., (*15)
imports is used to make <styles> tag with CSS contents in the mail message itself. This should be as short as
possible - usually only for rules that cannot be inlined, like this one:, (*16)
@import url("//fonts.googleapis.com/css?family=Ubuntu:400,400italic,700,700italic&subset=latin,latin-ext");
That's why it's called imports in configuration., (*17)
Why <styles> instead of <link>? To avoid remote resource loading, which is also most commonly disabled by default., (*18)
Changing created message
Use createMessage instead of sendMessage with same parameters in renderer,
change or add any required fields and send with swift mailer manually., (*19)
Wallogit.com
