Noodles, Poodles and More!

    nodemailer-handlebars

    1.0.1 • Public • Published

    Express Handlebars plugin for Nodemailer

    This plugin works with nodemailer 4.x. And uses the express-handlebars view engine to generate html emails.

    Install from npm

    npm install nodemailer-handlebars

    Usage

    //reference the plugin
    var hbs = require('nodemailer-handlebars');
    //attach the plugin to the nodemailer transporter
    transporter.use('compile', hbs(options));
    //send mail with options
    var mail = {
       from: 'from@domain.com',
       to: 'to@domain.com',
       subject: 'Test',
       template: 'email',
       context: {
           name: 'Name'
       }
    }
    transporter.sendMail(mail);

    Plugin Options

    The plugin expects the following options:

    • viewEngine (required) either the express-handlebars view engine instance or options for the view engine
    • viewPath (required) provides the path to the directory where your views are
    • extName the extension of the views to use (defaults to .handlebars)

    Mail options

    Set the template and values properties on the mail object before calling sendMail

    • template the name of the template file to use
    • context this will be passed to the view engine as the context as well as view engine options see here

    License

    MIT

    Install

    npm i nodemailer-handlebars

    DownloadsWeekly Downloads

    1,488

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    6.37 kB

    Total Files

    8

    Last publish

    Collaborators

    • accimeesterlin