api documentation for express-mailer (v0.3.1)

Send Emails from your express application

module express-mailer
1. function express-mailer.extend (app, options)
2. object express-mailer.express_mailer
module express-mailer.express_mailer
1. function express-mailer.express_mailer.extend (app, options)

module express-mailer

function express-mailer.extend (app, options)

description and source-code

extend = function (app, options) {

  if (app.mailer) {
    throw new Error('Application already has been extended with Express-Mailer!');
  };

  var mailer = {},
      from = options.from, // sender address
      transportMethod = options.transportMethod || 'SMTP',
      smtpTransport = nodemailer.createTransport(transportMethod, options),
      stubTransport,
      sendMail,
      createRender,
      createSend;

  /**
   * .sendMail
   *
   * Renders an enitre email using the given template and locals;
   *
   * @param {String|Object} template|sendOptions
   * @param {Object} locals (template local variables)
   * @param {Object} transport (nodemailer transport)
   * @param {Function} render (app.render or res.render)
   * @param {Function} callback
   * @api private
   */
  sendMail = function (sendOptions, locals, transport, render, callback) {
    var template;
    if (typeof sendOptions === "string") {
      template = sendOptions;
      sendOptions = {};
    } else {
      template = sendOptions.template;
    };

    render(template, locals, function (err, html) {
      if (err) {
        callback(err);
        return;
      };

      sendOptions.from = sendOptions.from || from;
      sendOptions.generateTextFromHTML = true;
      sendOptions.html = html;

      // Taken from NodeMailer (libs/nodemailer.js v0.7.1 line 251)
      var acceptedFields = ['from', 'sender', 'to', 'subject', 'replyTo', 'debug',
          'reply_to', 'cc', 'bcc', 'body', 'text', 'html',
          'envelope', 'inReplyTo', 'references', 'attachments'];

      locals = locals || {};
      for(var i=0;i<acceptedFields.length;i++){
          var field = acceptedFields[i];
          sendOptions[field] = sendOptions[field] || locals[field];
      }

      transport.sendMail(sendOptions, function (err, res) {
        if (err) {
          callback(err);
          return;
        } else {
          callback(null, res.message);
        };
      });
    });
  };

  createRender = function (render) {
    return function (sendOptions, locals, callback) {
      if (!stubTransport) {
        stubTransport = nodemailer.createTransport('Stub', options);
      };
      sendMail(sendOptions, locals, stubTransport, render, callback);
    };
  };

  createSend = function (render) {
    return function (sendOptions, locals, callback) {
      sendMail(sendOptions, locals, smtpTransport, render, callback);
    };
  };

  /**
   * .render
   *
   * Renders an enitre email using the given template and locals;
   *
   * @param {String|Object} template|sendOptions
   * @param {Object} locals (template local variables)
   * @param {Function} callback
   * @api public
   */
   mailer.render = createRender(app.render.bind(app));

  /**
   * .send
   *
   * Sends an email using the given template and locals;
   *
   * @param {String|Object} template|sendOptions
   * @param {Object} locals (template local variables)
   * @param {Function} callback
   * @api public
   */
  mailer.send = createSend(app.render.bind(app));

  /**
   * .update
   *
   * Updates the settings for mailer and callsback when ready;
   *
   * @param {Object} options
   * @param {Function} callback
   * @api public
   */
  mailer.update = function (options, callback) {
    smtpTransport.close(function (err) {
      if (err) {
        callback(err);
        return;
      };
      from = options.from;
      transportMethod = options.transportMethod || 'SMTP';
      smtpTransport = nodemailer.createTransport(transportMethod, options);
      callback(null);
    });
  };

  // Add .mailer to res object
  app.use(function (req, res, next) {
    res.mailer = {
      render: createRender(res.render.bind(res)),
      send: createSend(res.render.bind(res)),
      update: mailer.update
    };
    next();
  });

  app.mailer = mailer;

  return app;

}

example usage

...

```javascript
// project/app.js

var app = require('express')(),
  mailer = require('express-mailer');

mailer.extend(app, {
from: 'no-reply@example.com',
host: 'smtp.gmail.com', // hostname
secureConnection: true, // use SSL
port: 465, // port for secure SMTP
transportMethod: 'SMTP', // default is SMTP. Accepts anything that nodemailer accepts
auth: {
  user: 'gmail.user@gmail.com',
...

module express-mailer.express_mailer

function express-mailer.express_mailer.extend (app, options)

description and source-code

extend = function (app, options) {

  if (app.mailer) {
    throw new Error('Application already has been extended with Express-Mailer!');
  };

  var mailer = {},
      from = options.from, // sender address
      transportMethod = options.transportMethod || 'SMTP',
      smtpTransport = nodemailer.createTransport(transportMethod, options),
      stubTransport,
      sendMail,
      createRender,
      createSend;

  /**
   * .sendMail
   *
   * Renders an enitre email using the given template and locals;
   *
   * @param {String|Object} template|sendOptions
   * @param {Object} locals (template local variables)
   * @param {Object} transport (nodemailer transport)
   * @param {Function} render (app.render or res.render)
   * @param {Function} callback
   * @api private
   */
  sendMail = function (sendOptions, locals, transport, render, callback) {
    var template;
    if (typeof sendOptions === "string") {
      template = sendOptions;
      sendOptions = {};
    } else {
      template = sendOptions.template;
    };

    render(template, locals, function (err, html) {
      if (err) {
        callback(err);
        return;
      };

      sendOptions.from = sendOptions.from || from;
      sendOptions.generateTextFromHTML = true;
      sendOptions.html = html;

      // Taken from NodeMailer (libs/nodemailer.js v0.7.1 line 251)
      var acceptedFields = ['from', 'sender', 'to', 'subject', 'replyTo', 'debug',
          'reply_to', 'cc', 'bcc', 'body', 'text', 'html',
          'envelope', 'inReplyTo', 'references', 'attachments'];

      locals = locals || {};
      for(var i=0;i<acceptedFields.length;i++){
          var field = acceptedFields[i];
          sendOptions[field] = sendOptions[field] || locals[field];
      }

      transport.sendMail(sendOptions, function (err, res) {
        if (err) {
          callback(err);
          return;
        } else {
          callback(null, res.message);
        };
      });
    });
  };

  createRender = function (render) {
    return function (sendOptions, locals, callback) {
      if (!stubTransport) {
        stubTransport = nodemailer.createTransport('Stub', options);
      };
      sendMail(sendOptions, locals, stubTransport, render, callback);
    };
  };

  createSend = function (render) {
    return function (sendOptions, locals, callback) {
      sendMail(sendOptions, locals, smtpTransport, render, callback);
    };
  };

  /**
   * .render
   *
   * Renders an enitre email using the given template and locals;
   *
   * @param {String|Object} template|sendOptions
   * @param {Object} locals (template local variables)
   * @param {Function} callback
   * @api public
   */
   mailer.render = createRender(app.render.bind(app));

  /**
   * .send
   *
   * Sends an email using the given template and locals;
   *
   * @param {String|Object} template|sendOptions
   * @param {Object} locals (template local variables)
   * @param {Function} callback
   * @api public
   */
  mailer.send = createSend(app.render.bind(app));

  /**
   * .update
   *
   * Updates the settings for mailer and callsback when ready;
   *
   * @param {Object} options
   * @param {Function} callback
   * @api public
   */
  mailer.update = function (options, callback) {
    smtpTransport.close(function (err) {
      if (err) {
        callback(err);
        return;
      };
      from = options.from;
      transportMethod = options.transportMethod || 'SMTP';
      smtpTransport = nodemailer.createTransport(transportMethod, options);
      callback(null);
    });
  };

  // Add .mailer to res object
  app.use(function (req, res, next) {
    res.mailer = {
      render: createRender(res.render.bind(res)),
      send: createSend(res.render.bind(res)),
      update: mailer.update
    };
    next();
  });

  app.mailer = mailer;

  return app;

}

example usage

...

```javascript
// project/app.js

var app = require('express')(),
  mailer = require('express-mailer');

mailer.extend(app, {
from: 'no-reply@example.com',
host: 'smtp.gmail.com', // hostname
secureConnection: true, // use SSL
port: 465, // port for secure SMTP
transportMethod: 'SMTP', // default is SMTP. Accepts anything that nodemailer accepts
auth: {
  user: 'gmail.user@gmail.com',
...

[ this document was created with utility2 ]

api documentation for express-mailer (v0.3.1)

Send Emails from your express application

table of contents

module express-mailer

function express-mailer.extend (app, options)

module express-mailer.express_mailer

function express-mailer.express_mailer.extend (app, options)