mm-node-mailer v0.0.7

mm-node-mailer

A node module for sending e-mails.

Installation

$ npm install mm-node-mailer --save

Configuration

The mm-node-mailer is based upon the awesome Nodemailer, so you will have to configure it before usage.

Config options:

• config: the nodemailer configuration. See nodemailer-smtp-transport for full description of config fields, default: {}.
• templatesDir: the templates directory path, default ''
• templateEngineOptions: the template engine options e.g. helpers, partials etc. See node-email-templates for options, default {}

Note: The handlebars is use as template engine in this module.

Mail options:

• mail: the to, from, cc, etc, fields for all emails. See e-mail-message-fields for full description of email fields, default has two attributes templateName and templateContent.
  • templateName: the template folder name that is store in templates directory, default ''
  • templateContent: the template JSON content, default {}

Usage

Text email

var mailer = new mmMailer({
    config: {
        service: 'Gmail',
        auth: {
            user: 'test@gmail.com',
            pass: 'password'
        }
    }
});
var mailOptions = {
    from: 'test@gmail.com',
    to: 'your.email@address.com',
    subject: 'Hello',
    text: 'Hello world!',
    html: '<b>Hello world!</b>'
}
mailer.send(mailOptions, function (err, data) {
    if (err) return console.error(err);
    console.log('An e-mail has been sent successfully. Server responded with "' + data + '"');
});

Template email

var mailer = new mmMailer({
    config: {
        service: 'Gmail',
        auth: {
            user: 'test@gmail.com',
            pass: 'password'
        }
    },
    templatesDir: path.resolve(__dirname + '/templates'),
    templateEngineOptions: {
        helpers: {
            uppercase: function (context) {
                return context.toUpperCase();
            }
        }
    }
});
var mailOptions = {
    from: 'test@gmail.com',
    to: 'your.email@address.com',
    subject: 'Newsletter'
    templateName: 'newsletter',
    templateContent: {
        email: 'mamma.mia@spaghetti.com',
        name: {
            first: 'Mamma',
            last: 'Mia'
        }
    }
}
mailer.send(mailOptions, function (err, data) {
    if (err) return console.error(err);
    console.log('An e-mail has been sent successfully. Server responded with "' + data + '"');
});

Examples

Clone the mm-node-mailer repo and then install all dependencies:

$ git clone git@github.com:martinmicunda/mm-node-mailer.git 
$ cd mm-node-mailer
$ npm install 

Then run whichever example you want:

$ cd examples
$ EMAIL=your.email@address.com node email 

or

$ EMAIL=your.email@address.com node template-email 

You can also view live examples here:

Tests

To run the test suite, first invoke the following command within the repo, installing the development dependencies:

$ npm install

Then run the tests:

$ npm test

License

The MIT License

Copyright (c) 2014 Martin Micunda  

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.