About Mail Branding

Add a wrapper around bodyHTML.

Category 1Markup Generation
Markup modules that are called upon to generate or parse markup (like HTML). Markup modules are most often used on the front-end of a site (rather than admin).
Category 2Other Modules
Modules that have a unique purpose not covered by existing categories.
Release StateBeta
Close to stable, but users are advised to be cautious and test thoroughly.*
Authormartijn-geerts
Module Version0.1.3
Class NameWireMailBranding
Compatibility2.6, 2.7
Date AddedOctober 28, 2015
Last UpdatedNovember 13, 2015
Recommended ByNew recommendations may take up to 1 day to appear.

Instructions

This module's files should be placed in /site/modules/WireMailBranding/
How to install or uninstall modules

README

WireMailBranding

Add email templates to wireMail

How it works?

Create an email template without content. On the spot where you wish to have your content place the tag {bodyHTML}. The markup you've set with $mail->bodyHTML('<p>Markup</p>'); will replace that tag.

Setting the defaults

Go to the module settings and set the path to your email template. Make sure it is an absolute URL. Optionally you could inline all CSS with Emogrifier when you add a CSS file. The CSS file needs to be placed in the same folder, have the same basename as the wrapper and should end with the .css extension.

When using the Emogrifier CSS inliner applying it on the bodyHTML only is the most efficient way. We recommend you to write the inline styles for the wrapper manually.

Overwriting the defaults

The API overwrites the settings set in the module configuration.

$mail = wireMail();
$mail->to('user@some-domain.ext')->from('you@own-domain.ext');
$mail->subject('Mail Subject');
// Overwrite the Absolute URL
$mail->template('/site/templates/template_wrapper.php');
// Overwrite the Emogrifier CSS inliner. (0, bodyHTML, wrapper)
$mail->inlineCSS('bodyHTML');
$mail->bodyHTML('<p>This paragraph will replace the {bodyHTML} tag in the mail template.</p>');
$mail->send();

The added methods

// Disable the wrapper template* (Just send the bodyHTML)
$mail->template('');
// Disable the Emogrifier inliner
$mail->inlineCSS(0);
// Apply only on bodyHTML. (optimal when using Emogrifier inliner)
$mail->inlineCSS('bodyHTML');
// Apply over the complete HTML.
$mail->inlineCSS('wrapper');

Thanks!

This module is written by Martijn Geerts and sponsored by Calago.nl.

Comments

No comments yet. Be the first to post!

Post a Comment

Your e-mail is kept confidential and not included with your comment. Website is optional.