NodeMailer-Wrapper

Nodemailer-Wrapper is a utility module which provides a wrapper for NodeMailer NodeMailer that uses MongoDB as the backend. This utility is built with asynchronously in mind as a batch or cron worker, I suggest to use Node-Cron which runs perfectly with this.

This module designed for use with Node.js and installable via npm install nodemailer-wrapper,

Usage (basic):

var nodeMailer = require('nodemailer-wrapper');

var transportConfig = {
  transportType: 'smtp',
  config: {
    host: 'your-mail-server-host', // hostname
    secureConnection: false, // TLS requires secureConnection to be false
    port: 587, // port for secure SMTP
    auth: {
      user: 'your-username@mail-server',
      pass: 'your-password'
    },
    // use up to 20 parallel connections
    maxConnections: 20,
    // do not send more than 10 messages per connection
    maxMessages: 10,
    tls: {
      rejectUnauthorized: false // for non-authorized mail server
    }
  }
};

// use your mongodb address
var mongodbConfig = 'mongodb://localhost:27017/mailerDemo';

// create new wrapper instance
var mailer = new nodeMailer(mongodbConfig, transportConfig);

var mail1 = {
  from: 'your-mail@mail-server',
  to: 'target-mail@mail-server',
  subject: 'hello world',
  text: 'hello world!',
  html: '<b>Hello World! </b>'
};

var mail2 = {
  from: 'your-mail@mail-server',
  to: 'target-mail-2@mail-server',
  subject: 'hello world',
  text: 'hello world!',
  html: '<b>Hello World! </b>',
  attachments: [{ 
    filename: 'README.md',
    path: './demo.txt'
  }]
};

mailer.prepareMail(mail1);
mailer.prepareMail(mail2);

mailer.saveMails(function(err) {
  console.info('mails have been saved !');

  mailer.send(function(err) {
    if (err) console.log(err);
  });
});

More Example

Please check NodeMailer for more detail about mail data parameters.

Database Related

There are 2 tables created for this utility to works:

• mail_outboxes: which hold all the emails that is goint to send
• mail_sents: hold all sent emails

To save email into database, at least the database connection info required on the instance creation. Example:

// create new wrapper instance without transportation configuration
// usefull for adding emails into database only and without actually sending it
var mailer = new nodeMailer(mongodbConfig);

Please check the models source code for more detail about the table schema.

License

MIT