Emailing Starter Kit

Starter kit to create, inline, translate and send responsive emails using Zurk ink

Zurb Ink v2 with gulp, sass, inky, browserSync, image compression

Table of Contents

1. Installation
2. Configuration
3. Integration
4. Usage
5. Todo & Extend
6. Docs & Links

Installation

Just clone the repo and install the necessary node modules:

$ git clone https://github.com/quentinneyraud/mailing-starter-kit.git
$ cd mailing-starter-kit
$ npm install                   # Install Node modules

Configuration

All configuration files are in config folder

email

• Subjects and lists of emails indexed by languages

emailService

• Configuration used by Email API
• debugEmail to test email sending

project

• Source and dist folders
• translate to translate emails

translations

• lang you want to translate
• <string to replace> : <translation>

Integration

Write your email like an HTML page with id, class and a separate style.css Use Zurb Ink to make it responsive (Docs & Links)

Usage

• npm run build : inline CSS (& translate)
• npm run send:dev : send each email to debugEmail
• npm run send:prod : send all emails
• npm run watch : coming soon

Todo & extend

Todo

• watch task with browser-sync

Extend

To use a different email API :

• Create MyCustomEmailService in EmailService folder
• Set emailTransporter: MyCustomEmailService in project config file

Docs & Links

• Templates in templates_examples
• Zurb Ink doc
• Building Responsive Email Templates with Ink
• CSS Support Guide for Email Clients
• Zurb Ink Snippets - ST3