Node.js module for rendering beautiful emails with your template engine and CSS pre-processor of choice coupled with email-friendly inline CSS using juice.
View documentation here http://documentup.com/niftylettuce/node-email-templates.
Follow @niftylettuce on Twitter for updates.
Like this module? Check out express-cdn!
| The Rebel's Guide to Email Marketing | Modern HTML Email | Email Marketing By the Numbers |
|---|---|---|
 |
 |
 |
- Email Templates
- Installation
- Quick Start
- EJS Custom Tags
- Examples
- Lazyweb Requests
- Changelog
- Contributors
- License
For professional and customizable email templates, please visit https://github.com/mailchimp/Email-Blueprints.
This module depends on jsdom which requires the ability to compile C++ on your localhost. Before installing, please verify that you have the prerequisites installed for your OS.
Developing on osx/linux is recommended but if you only have access to a Windows machine you can either:
- Use vagrant to create a linux dev environment (recommended)
- Follow the Windows installation guide for contextify
npm install email-templates- Install the module for your respective project
npm install email-templates. - Create a folder called
templatesinside your root directory (or elsewhere). - For each of your templates, respectively name and create a folder inside the
templatesfolder. - Add the following files inside the template's folder:
html.{{template engine}}- See supported template engines (required)text.{{template engine}}- See supported template engines (optional)style.{{CSS pre-processor}}- See supported CSS pre-processors (optional)
- You may use the
includedirective from ejs (for example, to include a common header or footer). See the/examplesfolder for details. - Utilize one of the examples below for your respective email module and start sending beautiful emails!
Want to use different opening and closing tags instead of the EJS's default <% and %>?.
...
emailTemplates(templatesDir, { open: '{{', close: '}}' }, function(err, template) {
...NOTE: You can also pass other options from EJS's documentation.
Render a template for a single email or render multiple (having only loaded the template once).
var path = require('path')
, templatesDir = path.join(__dirname, 'templates')
, emailTemplates = require('email-templates');
emailTemplates(templatesDir, function(err, template) {
// Render a single email with one template
var locals = { pasta: 'Spaghetti' };
template('pasta-dinner', locals, function(err, html, text) {
// ...
});
// Render multiple emails with one template
var locals = [
{ pasta: 'Spaghetti' },
{ pasta: 'Rigatoni' }
];
var Render = function(locals) {
this.locals = locals;
this.send = function(err, html, text) {
// ...
};
this.batch = function(batch) {
batch(this.locals, this.send);
};
};
template('pasta-dinner', true, function(err, batch) {
for(var user in users) {
var render = new Render(users[user]);
render.batch(batch);
}
});
});var path = require('path')
, templatesDir = path.resolve(__dirname, '..', 'templates')
, emailTemplates = require('email-templates')
, nodemailer = require('nodemailer');
emailTemplates(templatesDir, function(err, template) {
if (err) {
console.log(err);
} else {
// ## Send a single email
// Prepare nodemailer transport object
var transport = nodemailer.createTransport("SMTP", {
service: "Gmail",
auth: {
user: "[email protected]",
pass: "some-password"
}
});
// An example users object with formatted email function
var locals = {
email: '[email protected]',
name: {
first: 'Mamma',
last: 'Mia'
}
};
// Send a single email
template('newsletter', locals, function(err, html, text) {
if (err) {
console.log(err);
} else {
transport.sendMail({
from: 'Spicy Meatball <[email protected]>',
to: locals.email,
subject: 'Mangia gli spaghetti con polpette!',
html: html,
// generateTextFromHTML: true,
text: text
}, function(err, responseStatus) {
if (err) {
console.log(err);
} else {
console.log(responseStatus.message);
}
});
}
});
// ## Send a batch of emails and only load the template once
// Prepare nodemailer transport object
var transportBatch = nodemailer.createTransport("SMTP", {
service: "Gmail",
auth: {
user: "[email protected]",
pass: "some-password"
}
});
// An example users object
var users = [
{
email: '[email protected]',
name: {
first: 'Pappa',
last: 'Pizza'
}
},
{
email: '[email protected]',
name: {
first: 'Mister',
last: 'Geppetto'
}
}
];
// Custom function for sending emails outside the loop
//
// NOTE:
// We need to patch postmark.js module to support the API call
// that will let us send a batch of up to 500 messages at once.
// (e.g. <https://github.com/diy/trebuchet/blob/master/lib/index.js#L160>)
var Render = function(locals) {
this.locals = locals;
this.send = function(err, html, text) {
if (err) {
console.log(err);
} else {
transportBatch.sendMail({
from: 'Spicy Meatball <[email protected]>',
to: locals.email,
subject: 'Mangia gli spaghetti con polpette!',
html: html,
// generateTextFromHTML: true,
text: text
}, function(err, responseStatus) {
if (err) {
console.log(err);
} else {
console.log(responseStatus.message);
}
});
}
};
this.batch = function(batch) {
batch(this.locals, templatesDir, this.send);
};
};
// Load the template and send the emails
template('newsletter', true, function(err, batch) {
for(var user in users) {
var render = new Render(users[user]);
render.batch(batch);
}
});
}
});This example utilizes Postmark.js.
NOTE: Did you know nodemailer can also be used to send SMTP email through Postmark? See this section of their Readme for more info.
For more message format options, see this section of Postmark's developer documentation section.
var path = require('path')
, templatesDir = path.resolve(__dirname, '..', 'templates')
, emailTemplates = require('email-templates')
, postmark = require('postmark')('your-api-key');
emailTemplates(templatesDir, function(err, template) {
if (err) {
console.log(err);
} else {
// ## Send a single email
// An example users object with formatted email function
var locals = {
email: '[email protected]',
name: {
first: 'Mamma',
last: 'Mia'
}
};
// Send a single email
template('newsletter', locals, function(err, html, text) {
if (err) {
console.log(err);
} else {
postmark.send({
From: 'Spicy Meatball <[email protected]>',
To: locals.email,
Subject: 'Mangia gli spaghetti con polpette!',
HtmlBody: html,
TextBody: text
}, function(err, response) {
if (err) {
console.log(err.status);
console.log(err.message);
} else {
console.log(response);
}
});
}
});
// ## Send a batch of emails and only load the template once
// An example users object
var users = [
{
email: '[email protected]',
name: {
first: 'Pappa',
last: 'Pizza'
}
},
{
email: '[email protected]',
name: {
first: 'Mister',
last: 'Geppetto'
}
}
];
// Custom function for sending emails outside the loop
//
// NOTE:
// We need to patch postmark.js module to support the API call
// that will let us send a batch of up to 500 messages at once.
// (e.g. <https://github.com/diy/trebuchet/blob/master/lib/index.js#L160>)
var Render = function(locals) {
this.locals = locals;
this.send = function(err, html, text) {
if (err) {
console.log(err);
} else {
postmark.send({
From: 'Spicy Meatball <[email protected]>',
To: locals.email,
Subject: 'Mangia gli spaghetti con polpette!',
HtmlBody: html,
TextBody: text
}, function(err, response) {
if (err) {
console.log(err.status);
console.log(err.message);
} else {
console.log(response);
}
});
}
};
this.batch = function(batch) {
batch(this.locals, templatesDir, this.send);
};
};
// Load the template and send the emails
template('newsletter', true, function(err, batch) {
for(user in users) {
var render = new Render(users[user]);
render.batch(batch);
}
});
}
});These are feature requests that we would appreciate contributors for:
- Rewrite this module to have a more modular API (e.g. template caching and email queue support via kue)
- Merge with @superjoe30 swig email templates fork
- Add parsing of HTML with CSS inlining and HTML linting
- Nick Baugh [email protected]
- Andrea Baccega [email protected]
- Nic Jansma (http://nicj.net)
- Jason Sims [email protected]
- Miguel Mota [email protected]
The MIT License
Copyright (c) 2012- Nick Baugh [email protected] (http://niftylettuce.com/)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.