Trippnology/hapi-mailer

Hapi Mailer

This is a fork of @nesive/hapi-mail that was created after the original package was pulled. This package has been renamed to @trippnology/hapi-mailer and the version reset to 1.0.0 to avoid conflicts.

A wrapper around Nodemailer used for sending email. It can be used with or without a template engine.

Installation

npm install --save @trippnology/hapi-mailer

Usage

Server configuration:

The plugin accepts the following configuration options:

• transport: A Nodemailer transport mechanism. If it is not set nodemailer-direct-transport transport is used. If it is a regular object nodemailer-smtp-transport is used and the value is passed as SMTP configuration.
• views: The views configuration as described in the server's views option. Note that due to the way node require() operates, plugins must require rendering engines directly and pass the engine using the engines.module option. Note that relative paths are relative to the plugin root, not the working directory or the application registering the plugin.
• inlineImages: A boolean value to convert Base64 images to attachments. Defaults to true.
• inlineStyles: A boolean value to inline CSS in <style> tags. Defaults to true.

Example:

const Handlebars = require('handlebars');
const Path = require('path');
const Vision = require('vision');

const HapiMailer = {
  register: require('@trippnology/hapi-mailer'),
  options: {
    transport: {
      service: 'Gmail',
      auth: {
        user: 'example@gmail.com',
        pass: 'password'
      }
    },
    views: {
      engines: {
        html: {
          module: Handlebars.create(),
          path: Path.join(__dirname, 'src/views/emails')
        }
      }
    }
  }
};

server.register([Vision, HapiMailer], (err) => {
  // ...
});

Handler:

In handlers, the Mailer object can be accessed as request.server.plugins['hapi-mailer']. It has a send() function which can be used to send an email. It accepts the following configuration options:

• data: Defines the mail content the same way as Nodemailer. There is only one additional property context, which is an optional object used by the template to render context-specific result.
• callback: It is a callback function to run once the message is delivered or it failed.

Example:

const handler = function(request, reply) {
  const data = {
    from: 'example@gmail.com',
    to: 'to@example.com',
    subject: 'Example Subject',
    html: {
      path: 'handlebars.html'
    },
    context: {
      name: 'Example User'
    }
  };

  const Mailer = request.server.plugins['hapi-mailer'];
  Mailer.send(data, (err, info) => reply());
};

server.route({ method: 'POST', path: '/', handler: handler });