byteskode-mailer

byteskode sendgrid mailer with mongoose persistence and kue support

Note: mailer is configured using config using key mailer

Requirements

• mongoose

Installation

$ npm install --save mongoose byteskode-mailer

Usage

var mongoose = require('mongoose');
var Mail = require('byteskode-mailer');
 
//mail + template data
var mail = {
    recipientName: faker.name.findName(),
    token: faker.random.uuid(),
    to: faker.internet.email(),
    baseUrl: faker.internet.url(),
    subject: 'Account confirmation',
    type:'confirmation'
};
 
//send immediate
Mail
    .send(mail, function(error, mail){
            ...
    });
 
//queue for later sending
//you will have to implement worker for later resend
Mail.queue(mail);
 

API

send(email:Object,[options:Object], callback(error, mail))

Send will compile mail template found at a path obtain using the type parameter and templateDir configuration options and set html value to data. View for sample template directory layout.

Before send all mails are persisted to mongodb using mongoose. mail object should constitute valid nodemailer email fields plus other data to be passed to mail template.

If running in production and still want to simulate fake sent pass an additional object with fake key set to true.

Note: Current attachment are not supported

Example

//mail + template data
var mail = {
    recipientName: faker.name.findName(),
    token: faker.random.uuid(),
    to: faker.internet.email(),
    baseUrl: faker.internet.url(),
    subject: 'Account confirmation'
};
 
//real send
Mail
    .send(mail, function(error, mail){
            ...
    });
 
//simulate send
Mail
    .send(mail, {fake:true}, function(error, mail){
            ...
    });

resend([criteria:Object], callback(error, mails))

Resend will try to resend failed mails that are in the database. criteria is a valid mongoose criteria used to specify which failed mails to resend.

Example

Mail.resend(fuction(error, mails){
    ...
});
 
//or pass criteria
Mail.resend(criteria, fuction(error, mails){
    ...
});

queue(mail:Object,[options:Object], [callback(error, mail)])

Unlike send, queue will save compiled email for later processing. After mail persisted into database mail:queued event will be fired with an instance of saved mail. If any error occur an event mail:queue:error will be fired.

Example

Mail.on('mail:queued', fuction(mail){
    ...
    //process mail in background or real queue like kue
    ...
});
 
Mail.on('mail:queue:error', fuction(error){
   ...
   //handle error
   ... 
});
 
//mail details + template data
var mail = {
    recipientName: faker.name.findName(),
    token: faker.random.uuid(),
    to: faker.internet.email(),
    baseUrl: faker.internet.url(),
    subject: 'Account confirmation',
    type:'confirmation' 
};
 
Mail.queue(mail);

requeue([criteria:Object], [callback(error, mail)])

Unlike resend, requeue will fire mail:queued event on every unsent mail.

Example

Mail.requeue();
 
//or pass criteria
Mail.requeue(criteria);

Configuration Options

Base on your environment setup, ensure you have the following configurations in your config files.

mailer: {
        from: '<yourname> <no-reply@<yourdomain>.com>',
        sender: '<sendername>',
        transport: {
            auth: {
                api_key: '<sendgrid_api_key>',
            }
        },
        model:{
            name:'<name_of_mongoose_model>',
            fields:<additional_schema_fields>
        },
        templatesDir:<path_to_ejs_template>,
        kue: { // ensure to install kue and add this to support kue
            concurrency: 10,
            timeout: 5000,
            connection: {}
        }
    }

Kue Integration

To add support to kue ensure you have installed kue and supply the required configuration. The presence of kue configuration in mailer config options will signal the use of kue publisher and worker. See Example

$ npm install --save kue

Kue Mail Worker

In your worker process start the queued mail worker as below

var mongoose = require('mongoose');
var Mail = require('byteskode-mailer');
 
//Alert!: Probably your should start mail processing in your worker process
//and not main process
Mail.worker.start();
 
//listen for the worker queue events
//all kue queue events are applicable here
Mail.worker.queue.on('job complete', function(id, result) {
    console.log(id, result);
});
 
//anywhere in your main process
//queue email for send
Mail.queue({
    recipientName: faker.name.findName(),
    token: faker.random.uuid(),
    to: faker.internet.email(),
    baseUrl: faker.internet.url(),
    subject: 'Account confirmation',
    html: faker.lorem.sentence(),
    sender: faker.internet.email(),
    from: faker.internet.email(),
    type: 'confirm'
});

Testing

• Clone this repository

• Install all development dependencies

$ npm install

• Then run test

$ npm test

Contribute

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

Licence

The MIT License (MIT)

Copyright (c) 2015 byteskode, lykmapipo & Contributors

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.