https://github.com/philister16/html-email
A simple way to generate html email templates in node applications.
https://github.com/philister16/html-email
handlebars html-emails html-views
Last synced: 10 days ago
JSON representation
A simple way to generate html email templates in node applications.
- Host: GitHub
- URL: https://github.com/philister16/html-email
- Owner: philister16
- Created: 2018-02-25T14:37:11.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-04-09T04:20:49.000Z (about 3 years ago)
- Last Synced: 2024-12-23T23:44:24.682Z (4 months ago)
- Topics: handlebars, html-emails, html-views
- Language: HTML
- Size: 378 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# HtmlEmail
## About
This module exposes a simple class to make it easy to generate html emails from node applications. It lets you define emails as json objects with any number of languages and variable content blocks and match these to independent html views. View and content remain separated and will be compiled at runtime with a little help of handlebars.
## Quick guide
Install the node module with npm.
```bash
$ npm install html-email --save
```
Create the email content template json file.
```json
{
"name": "welcome",
"view": "main",
"from": "Team {{country}}",
"content": {
"en": {
"subject": "Welcome, {{firstname}} {{lastname}}!",
"body": {
"heading": "Nice to meet you!",
"main": "Great to have you onboard. This is an email to just say Hi! Let us know if there is anything we can do for you and ask our lovely community for help, too. Now enjoy the ride.",
"footer": "See you around - the team"
}
},
"de": {
"subject": "Willkommen, {{firstname}} {{lastname}}",
"body": {
"heading": "Herzlich willkommen!",
"main": "Wir freuen uns dich bei uns begrüssen zu dürfen. Mit dieser Email wollen wir nur mal kurz Hallo sagen. Lass uns wissen wenn du fragen hast und unsere aktive Community hilft auch immer gern weiter. Viel Spass!",
"footer": "Bis bald - dein Team"
}
}
}
}
```
Create an html view that uses the contents of the template json. As many content blocks can be defined as variables in the json as needed. The content is dynamically placed in the document using the double curly braces handlebars syntax. The variables correspond with properties on the json's body object as well as with variables passed dynamically from the code (in this example only the 'link' variable).
```html
{{heading}}
{{main}}
{{footer}}