nodemailer-express-handlebars

KO | EN

gitlite — search

#hacktoberfest #react #typescript #android #deep-learning #docker #nodejs #java #cli #kubernetes #pytorch #openai #mcp #open-source

nodemailer-express-handlebars

(★ 92)

A plugin for nodemailer that uses express-handlebars view engine to generate emails

nodemailer-express-handlebars Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Express Handlebars plugin for Nodemailer
This plugin works with nodemailer 6.x. And uses the [express-handlebars](https://github.com/express-handlebars/express-handlebars) view
engine to generate html emails.

# Install from npm
```bash
npm install nodemailer-express-handlebars
```
# Usage
```javascript
//reference the plugin
import hbs from 'nodemailer-express-handlebars';
//attach the plugin to the nodemailer transporter
transporter.use('compile', hbs(options));
//send mail with options
const mail = {
   from: 'from@domain.com',
   to: 'to@domain.com',
   subject: 'Test',
   template: 'email',
   context: {
       name: 'Name'
   }
}
transporter.sendMail(mail);
```

You can send a multipart html and text email by setting the `text_template` option on a mail message.
```javascript
const mail = {
   from: 'from@domain.com',
   to: 'to@domain.com',
   subject: 'Test',
   template: 'email',
   text_template: 'text',
   context: {
       name: 'Name'
   }
}
```
## Plugin Options
The plugin expects the following options:
* __viewEngine (required)__ either the express-handlebars view engine instance or [options for the view engine](https://github.com/express-handlebars/express-handlebars#configuration-and-defaults)
* __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](https://github.com/express-handlebars/express-handlebars#renderviewviewpath-optionscallback-callback)

# License
MIT

nodemailer-express-handlebars

nodemailer-express-handlebars Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

nodemailer-express-handlebars

nodemailer-express-handlebars Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README