https://github.com/danibram/emailer-hbs

A super hero that helps you to have the full control of your emails in your API, powered by: Handlebars,Juice,Nodemailer and typescript.
https://github.com/danibram/emailer-hbs

emails handlebars juice nodemailer typescript

Last synced: 3 days ago
JSON representation

A super hero that helps you to have the full control of your emails in your API, powered by: Handlebars,Juice,Nodemailer and typescript.

• Host: GitHub
• URL: https://github.com/danibram/emailer-hbs
• Owner: danibram
• License: mit
• Created: 2017-02-12T14:22:25.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T09:36:47.000Z (about 2 years ago)
• Last Synced: 2024-11-18T22:33:10.496Z (2 months ago)
• Topics: emails, handlebars, juice, nodemailer, typescript
• Language: HTML
• Homepage:
• Size: 226 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# emailer-hbs

## What is this?

`emailer-hbs` is a super hero that helps you to have the full control of your emails in your API. Its powered by:

- HandlebarsJS

- Juice

- Nodemailer

- Typescript

It takes an array of configuration and a folder with header footer or more partials and that template, it inlines css with juice, and compose the final email.

## Configuration for the Mailer

The configuration is very easy:

```

{

    overrideEmail: string|null,

    from: string|null,

    css: string[]

    input: string

    output: string

    templates: string

    partials: string

    transport: any,

    emailsDirectory: string

}

```

That is the explanation:

- overrideEmail: If this string exists, it override the email you pass by the email you want, easy for devs to test it

- from: general from, can be override if you, send from parameter to renderAndSend

- css: Array of css paths you want to use in the emails

- input: Where are your templates

- output: Where you want to compile that templates

- templates: Where inside the input are the templates

- partials: Where inside the input are the partials

- transport: Nodemailer Transport with your config ready

- emailsDirectory: Path of your emails configuration

## Emails configuration

An example of an email configuration:

```

{

    title: string

    template: string

    body: string

    data: string[]

    dummyData: {}

    composeData(input: Object): Object

}

```

That is the explanation:

- title: Title of your email

- template: Name of the template, inside your template folder

- data: Array of the key you need to pass as config

- dummyData: Dummy data for the emails, to test it

- composeData: Function to parse the input data

## How to use it

```npm install emailer-hbs```

```

import { Emailer } from 'emailer-hbs'

import config from '../config'

if (config.env !== 'development' && config.mailer.overrideEmail) {

    config.mailer.overrideEmail = null

}

export default new Emailer(config.mailer)

```

OR

```

import Mailer from 'emailer-hbs'

import config from '../config'

if (config.env !== 'development' && config.mailer.overrideEmail) {

    config.mailer.overrideEmail = null

}

let mailer = Mailer(config.mailer)

```

## Folders

This is han example, of the folders i use, in src you have the templates and the common parts, of the emails, then when you cache the emails goes to cache folder, partials are like swig partials but for use in handlebars really easy, end the css with the juice power tranform the css in inline css.

```

templates

├── cache

│   ├── partials

│   │   ├── base.html

│   │   └── footer.html

│   └── templates

│       ├── access.html

│       └── welcome.html

└── src

    ├── css

    │   ├── ink-emails.css

    │   ├── ink.css

    │   └── style.css

    ├── partials

    │   ├── base.html

    │   └── footer.html

    └── templates

        ├── access.html

        └── welcome.html

```

```

// Input

// base.html

    {{ Compile __body__ }}

    
Hi

    emailer-hbs 2017