A wrapper around Nodemailer used for sending email. It can be used with or without a template engine.
npm install --save @nesive/hapi-mailer
The plugin accepts the following configuration options:
transport
: A Nodemailer transport mechanism. If it is not setnodemailer-direct-transport
transport is used. If it is a regular objectnodemailer-smtp-transport
is used and the value is passed as SMTP configuration.views
: The views configuration as described in the server'sviews
option. Note that due to the way noderequire()
operates, plugins must require rendering engines directly and pass the engine using theengines.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 totrue
.inlineStyles
: A boolean value to inline CSS in<style>
tags. Defaults totrue
.
Example:
const Handlebars = require('handlebars');
const Path = require('path');
const Vision = require('vision');
const HapiMailer = {
register: require('@nesive/hapi-mailer'),
options: {
transport: {
service: 'Gmail',
auth: {
user: '[email protected]',
pass: 'password'
}
},
views: {
engines: {
html: {
module: Handlebars.create(),
path: Path.join(__dirname, 'src/views/emails')
}
}
}
}
};
server.register([Vision, HapiMailer], (err) => {
// ...
});
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 propertycontext
, 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: '[email protected]',
to: '[email protected]',
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 });