# node-transacemail

**Repository Path**: mirrors_FGRibreau/node-transacemail

## Basic Information

- **Project Name**: node-transacemail
- **Description**: Transactional Email & Templated Email for NodeJS done right 
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-05-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 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

I maintain this project in my free time, if it helped you please support my work via [paypal](https://paypal.me/fgribreau) or [bitcoins](https://www.coinbase.com/fgribreau), thanks a lot!

## License
Copyright (c) Francois-Guillaume Ribreau
Licensed under the MIT license.