UNPKG

transacemail

Version:

Transactional Email & Templated Email for NodeJS

github.com/FGRibreau/node-transacemail

FGRibreau/node-transacemail

37 lines (24 loc) • 1.65 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# Transactional Email & Templated Email for NodeJS done right [![Build Status](https://drone.io/github.com/FGRibreau/node-transacemail/status.png)](https://drone.io/github.com/FGRibreau/node-transacemail/latest) [![Code Climate](https://codeclimate.com/github/FGRibreau/node-transacemail.png)](https://codeclimate.com/github/FGRibreau/node-transacemail) ***Transacemail*** provides an organized way to handle transactional email while still being fully decoupled and modular. ## NPM Install the module with: `npm install transacemail` ## [Documentation](http://fgribreau.github.com/node-transacemail/docs/index.html) ## How to implement a TemplateEngine TemplateEngine are object that should implement the following methods: - `.compile(templateString) -> Function` - `.exec(fnCompiledTemplate, data) -> String` See `Mailing.templateEngine` in [Mailing.js](https://github.com/FGRibreau/node-transacemail/blob/master/lib/Mailing.js#L34). ## How to implement a MailProvider MailProviders just have to implement: `.send(mail, callback(err, success))`. See [node-transacemail-mandrill](http://github.com/FGRibreau/node-transacemail-mandrill). ## Contributing In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [grunt](https://github.com/cowboy/grunt). ## Release History v0.1.8 - Removed support for 0.6 v0.1.0 - Initial commit (4 fev. 2012) ## Donate [Donate Bitcoins](https://coinbase.com/checkouts/fc3041b9d8116e0b98e7d243c4727a30) ## License Copyright (c) 2013 Francois-Guillaume Ribreau Licensed under the MIT license.