Grunt Email Design Workflow

Designing and testing emails is a pain. HTML tables, inline CSS, various devices and clients to test, and varying support for the latest web standards.

This grunt task helps simplify things at the design stage.

Compiles your SCSS to CSS
Builds your email templates
Inlines your CSS
Uploads any images to a CDN (optional)
Sends you a test email to your inbox

Requirements

Node.js - Install Node.js
Grunt-cli and Grunt (npm install grunt-cli -g)
Ruby - Install ruby with RVM
Premailer (gem install premailer hpricot nokogiri) - Inlines the CSS
Mailgun (optional) - Sends the email
Litmus (optional) - Tests the email across all clients/browsers/devices
Rackspace Cloud (optional) - Uses Cloud Files as a CDN

Getting started

If you haven't used Grunt before check out Chris Coyier's post on getting started with Grunt.

Clone this repo, cd to the directory, run npm install to install the necessary packages.

git clone https://github.com/leemunroe/grunt-email-design.git
cd grunt-email-design
npm install
grunt

How it works

CSS

This project uses SCSS. You don't need to touch the .css files, these are compiled automatically.

For changes to CSS, modify the .scss files.

Media queries and responsive styles are in a separate style sheet so that they don't get inlined. Note that only a few clients support media queries e.g. iOS Mail app.

Email templates and content

Handlebars is used for templating.

/layouts contains the standard header/footer HTML markup. You most likely will only need one layout template, but you can have as many as you like.

/emails is where your email content will go. To start you off I've included example transactional emails based on my simple HTML email template.

Generate your email templates

In terminal, run grunt. This will:

Compile your SCSS to CSS
Generate your email layout and content
Inline your CSS

See the output HTML in the dist folder. Open them and preview it the browser.

Alternatively run grunt watch. This will check for any changes you make to your .scss and .hbs templates, then automatically run the tasks. Saves you having to run grunt every time.

Send the email to yourself

Sign up for a Mailgun account (it's free)
Open up Gruntfile.js
Replace 'MAILGUN_KEY' with your actual Mailgun API key
Change the sender and recipient to your own email address (or whoever you want to send it to)

Run grunt send --template=transaction.html. This will email out the template you specify.

Change 'transaction.html' to the name of the email template you want to send.

How to test with Litmus

If you have a Litmus account and want to test the email in multiple clients/devices, create a new test in Litmus, copy the email address they tell you to send the email to, open up Gruntfile.js and paste it where the recipient goes. Then run grunt send --template=TEMPLATE_NAME.html to send the email to Litmus.

CDN and working with image assets

If your email contains images you'll want to serve them from a CDN. This Gruntfile has support for Rackspace Cloud Files (pricing).

Sign up for a Rackspace Cloud account (use the Developer Discount for $300 credit)
Create a new Cloud Files container
Open up Gruntfile.js
Change 'cloudfiles' settings to your settings (you can find your Rackspace API key under your account settings)
Make any other config changes as per grunt-cloudfiles instructions

Run grunt cdnify to run the default tasks as well as upload any images to your CDN.

Run grunt cdnify send --template=branded.html to send the email to yourself with the 'CDNified' images.

Sample email templates

I've added two templates here to help you get started.

For more transactional email templates check out Mailgun's collection of templates.

wreckeddesign / grunt-email-design