Tippler

Markdown mailer for your products. When you usually build a product there comes a situation you need to relay on third party mailing solutions like Chipmunk for your mailing campaigns or for your newsletters to be sent out to your subscribers. For our product Sentinel, we didn't want to used any third party solutions to manage our mailing list, we decided to make use of Amazon SES as our mail servers and we needed a simple interface to create content for mails and send it to our subscribers. So we created Tippler.

N.B. Tippler is a breed of domestic homing pigeons.

Image source: Wikipedia

Basic aim and usage of Tippler

• Create mail content with easy to use markdown syntax. Tippler follows the Daring Fireball markdown syntax
• Design email supported HTML and CSS templates with internal styles sheets, Tippler uses the Swig template engine and Juice for converting internal styles to inline styles which are supported by email clients.
• Markdown will be parsed to HTML by Tippler and the parsed content will be inserted to the email template of your choice, which will be then sent to your users as email content.

Contribute

Extend Tippler to suit your needs, by default Tippler uses Amazon SES to send emails. Extend this project as you wish to load automatically your users from your mailing list as recipients and your own choice of mail server instead of Amazon SES.

Dependent Node modules:

• Nodemailer
• Juice
• Swig
• Markdown-js

Fork it and extend! Give a pull request when you think you have created some awesomeness.

Installation

• Clone Tippler git clone git@github.com:mindhelix/tippler.git
• Install dependent node modules cd tippler and npm install
• Set your AWS Access key, AWS Secret key and your SES verified sender email id in config.js(config/config.js), assuming that you will be using AWS SES for Tippler.
• Run tippler node app.js
• The local node server port is set to 3000 by default. Change it in config.js file if you need to.

• A default email compatible template with internal style is provided: templates/email-tpl.html. Edit this template or add your own templates with different styles to suit your needs. The template is passed to the swig template engine in compose.js file in routes

- @jinmatt