Handlebars Email
A Handlebars template engine for emails.
Handlebars provides the power necessary to let you build semantic templates effectively with no frustration.
Checkout the official Handlebars docs site at handlebarsjs.com or Give it a Try.
Installation
Use the npm package manager to install Handlebars Email.
npm i handlebars-emailUsage
Import Handlebars Email hbsEmail method.
hbsEmail( template, context ) take 2 argument a template & a context argument. Which will be used to render the final template.
- template - Path of the template with extension ( .hbs or .handlebars ) or template name if hbsEmailConfig is set.
- context - The actual context Object.
hbsEmailConfig()
- views - Views Path of the email template folder
- extname - template extension ( .hbs or .handlebars )
hbsEmailConfig({
views: "views/email/",
extname: ".hbs"
});Once you have a template, use the hbsEmail method to render the template by passing the template & context.
Example
email.js
const { hbsEmail } = require("handlebars-email");
const path = require("path");
const template = path.join("views", "email", "template.hbs");
const context = { message: "Hello World!" };
const eMailTemplate = hbsEmail(template, context);With hbsEmailConfig
const { hbsEmail, hbsEmailConfig } = require("handlebars-email");
hbsEmailConfig({
views: "views/email/",
extname: ".hbs",
});
const context = { message: "Hello World!" };
const eMailTemplate = hbsEmail("template", context);template.hbs
Would render:
<html>
<head>
<title>Message HTML Title</title>
</head>
<body>
<div>
<h2>Message:</h2>
<p>Hello World!</p>
</div>
</body>
</html>With Nodemailer
email.js
const { hbsEmail } = require("handlebars-email");
const nodemailer = require("nodemailer");
const path = require("path");
const template = path.join(__dirname, "/template.hbs");
const context = { message: "Hello World!" };
const eMailTemplate = hbsEmail(template, context);
const transporter = nodemailer.createTransport({
host: process.env.SMTP_HOST,
port: process.env.SMTP_PORT || 587,
secure: process.env.SMTP_PORT === 465, // true for 465, false for other ports
auth: {
user: process.env.SMTP_USERNAME,
pass: process.env.SMTP_PASSWORD,
},
});
const mailOptions = {
from: "sender@example.com", // Sender address
to: "receiver@example.com", // List of recipients
subject: "Node Mailer Handlebars Email", // Subject line
html: eMailTemplate, // Handlebars eMail template
};
transporter.sendMail(mailOptions, (error, email) => {
if (error) return console.log(error);
console.log("Message sent: %s", email.messageId);
});Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE.md for more information.