#Jademail

Simple jade email sender, with caching.

##How to include

Jademail requires an argument when require()d, this path is the email profiles folder

var jademail = require('jademail')('./folder/emails');

It automatically loads (and cache) all the profiles found in the subdirs, when done it calls the event 'profilesLoaded'

PATH NOTE:

PATH in this project is relative to the root of your Express application, ex: 'views/email', NOT '../../dir/folder'.

---

jademail.on('profilesLoaded', function (path) {
  console.log('Profile Path: %s loaded', path);
});

Text Templates

Jade is nice enough to let us use text files, just we need to insert '|' before each line.

Something like this:

                                     .__          Date: #{today}
  ____ ___  ________    _____ ______ |  |   ____  
_/ __ \\  \/  /\__  \  /     \\____ \|  | _/ __ \ 
\  ___/ >    <  / __ \|  Y Y  \  |_> >  |_\  ___/ 
 \___  >__/\_ \(____  /__|_|  /   __/|____/\___  >
     \/      \/     \/      \/|__|             \/ 

should become:

|                                     .__          Date: 8/7/2577
|  ____ ___  ________    _____ ______ |  |   ____  
|_/ __ \\  \/  /\__  \  /     \\____ \|  | _/ __ \ 
|\  ___/ >    <  / __ \|  Y Y  \  |_> >  |_\  ___/ 
| \___  >__/\_ \(____  /__|_|  /   __/|____/\___  >
|     \/      \/     \/      \/|__|             \/ 

Variables compiling, of course, works.

##Usage Example See examples

###Methods

// loads the entire collection of profiles found in the <path>
Jademail.loadAllProfiles( String path, Function callback )

// sends the mail profile specified by profileName, compiling with the provided locals
// jadeLocals, callback are *optional*
Jademail.Send( String profileName, Object emailHeaders, Object jadeLocals, Function callback )

// returns an Object containing email profiles, if verbose is true,
// returns additional informations regarding profiles
Jademail.listProfiles( Boolean verbose ) : Object

// re-reads stored path, or flushes cache and reads the newpath if provided
// newpath is optional, needed only if the path is different than the former one
Jademail.reloadProfiles( String newpath, Function callback )

// setups nodemailer transport object, it's always an SMTP transport type
Jademail.setTransport( Object transportObj )

###Events

// @profileAdded - Triggered when a new profile is loaded, this gets triggered
//                  multiple times during first istantiation (usually)
Jademail.on('profileAdded', function (String profileName){}) 

// @profilesLoaded - Triggered when a loadAllProfiles() gets completed
Jademail.on('profilesLoaded', function (String path){});

// @emailSent - An email is sent, recipient(s) gets returned
Jademail.on('emailSent', function (Object nodemailerObj, String profileName, Date sendDate){});

###Dependencies

#####Nodemailer v0.3.37 or up Main library needed to send mail.

#####juice v0.0.7 or up Library for inline CSS compiling, looking for a better (mantained) one.

#####async v0.1.23 or up Useful for asynchronous functions in NodeJS