plugin-mail

The mail plugin wraps itself over the nodemailer module to send out HTML templates. For the best experience, it should be used with the render-plugin, in order to define SWIG templates, render them dynamically and apply inline styling to them.

Installation and usage

# install the plugin
npm i --save thorin-plugin-mail@1.x
# install your preferred nodemailer transport, eg. mailgun
npm i --save nodemailer-mailgun-transport@1.x

'use strict';
// app.js entry file
const thorin = require('thorin');

thorin.addPlugin(require('thorin-plugin-mail'));   // <-- add this line
thorin.run((err) => {});

# run to setup folder structure
node app.js --setup=plugin.email

Default configuration

• transportarray(string)an array of transport names to use. If sent as strings, we will do a require() for the modules, otherwise, we will consider the actual object as the transport.
• optionsobject an object of {transportKey:{transportOptions}}. If you use only one transport, it will use the direct options object.
• fromstringgeneric from e-mail address
• templatesstring, app/emailsthe swig e-mail template path, relative to thorin.root
• renderstring, renderthe name of the thorin render plugin.
• enabledboolean, truesetting this to false will disable e-mail sending and just mock send.

'use strict';
// File: config/app.js
module.exports = {
   "plugin.email": {
      "transport": "mailgun",
         "options": {
         "from": "John Doe <no-reply@john-doc.com>",
         "auth": {
            "domain": "mydomain.com",
            "api_key": "YOUR_API_KEY"
         }
      }
   }
};

Plugin functionality

'use strict';
const pluginObj = thorin.plugin('mail');
thorin.dispatcher
   .addAction('mail.preview')
   .alias('GET', '/preview/:template')
   .input({
      template: dispatcher.validate('STRING')
   })
   .use((intentObj, next) => {
      pluginObj
         .prepare(intentObj.input('template'), intentObj.rawInput)
         .then((html) => {
            intentObj.rawResult(html);
            next();
         }).catch(next);
   });

'use strict';
const mailObj = thorin.plugin('mail');
thorin.dispatcher
  .addAction('mail.send')
  .input({
    to: dispatcher.validate('EMAIL').error('INVALID_EMAIL', 'Invalid to e-mail address'),
    subject: dispatcher.validate('STRING').default(null),
    template: dispatcher.validate('STRING').error('INVALID_TEMPLATE', 'Missing template'),
    params: dispatcher.validate('JSON').default({})
  })
  .use((intentObj, next) => {
    let data = intentObj.input();
    mailObj
      .send({
        to: data.to,
        subject: data.subject,
        template: data.template
      }, data.params)
      .then(() => {
        log.info(`Sent e-mail [${data.template}] to [${data.to}]`);
        next();
      })
      .catch((e) => {
        log.warn(`Failed to send e-mail [${data.template}] to [${data.to}]`);
        log.debug(e);
        next(e);
      });
  });

The plugin also registeres a custom middleware mail#preview which you can use to preview your e-mail templates in a development environment.

'use strict';
if (thorin.env === 'development') {
thorin.dispatcher
   .addAction('email.template.preview')
   .alias('GET', '/mail/preview')
   .use('mail#preview');
   // access /mail/preview?template=your/template.swig
}