apostrophe/lib/modules/apostrophe-email/index.js

The Apostrophe Content Management System.

var nodemailer = require('nodemailer');
var htmlToText = require('html-to-text');
var _ = require('@sailshq/lodash');

// ## Options
//
// ### `from`
//
// Default "from" address, with full name. Example:
//
// `'"Jane Doe" <jane@doe.com>'`
//
// `nodemailer`: **required.** Options object to be passed to nodemailer's
// `createTransport` method. See the [nodemailer](https://nodemailer.com)
// documentation.

module.exports = {

  construct: function(self, options) {

    // Implements the `email` method available in all modules.
    //
    // See `apostrophe-module` for coverage of the `email` method that
    // every module has. You won't need to call `emailForModule` directly.

    self.emailForModule = function(req, templateName, data, options, module, callback) {
      var transport = self.getTransport(req, data, options);
      var content = self.getContent(req, templateName, data, options, module);
      var args = _.assign({
        from: (module.options.email && module.options.email.from) || self.options.from
      }, content, options);
      if (process.env.APOS_LOG_EMAIL) {
        self.apos.utils.debug(args);
      }
      return transport.sendMail(args, callback);
    };

    // Compute the content of the email. This is an interesting override point
    // to add properties that will be passed to nodemailer transport when
    // sending the email.

    self.getContent = function(req, templateName, data, options, module) {
      var html = module.render(req, templateName, data);
      var text = htmlToText.fromString(html, {
        format: {
          heading: function(elem, fn, options) {
            var h = fn(elem.children, options);
            var split = h.split(/(\[.*?\])/);
            return split.map(function(s) {
              if (s.match(/^\[.*\]$/)) {
                return s;
              } else {
                return s.toUpperCase();
              }
            }).join('') + '\n';
          }
        }
      });
      return {
        html: html,
        text: text
      };
    };

    // Fetch the nodemailer-compatible transport object, that is going to be
    // used to send the email. It may be a convenient override point to decide
    // which transport to use according to the parameters passed. The default
    // implementation creates a transport via `nodemailer.createTransport`
    // on the first call, passing it the value of the `nodemailer` option
    // configured for the `apostrophe-email` module. If there is none,
    // a fatal error is thrown.

    self.getTransport = function(req, data, options) {
      if (!self.transport) {
        if (!self.options.nodemailer) {
          throw new Error('The nodemailer option must be configured for the apostrophe-email module before any module can call its email() method. The option accepts an object to be passed to nodemailer.createTransport, per the nodemailer documentation.');
        }
        self.transport = nodemailer.createTransport(self.options.nodemailer);
      }
      return self.transport;
    };

  }

};