https://github.com/pitops/mailframe

🚀 Small library that makes it super easy to manage and dispatch emails
https://github.com/pitops/mailframe

email-sender email-templates

Last synced: 11 months ago
JSON representation

🚀 Small library that makes it super easy to manage and dispatch emails

• Host: GitHub
• URL: https://github.com/pitops/mailframe
• Owner: pitops
• License: mit
• Created: 2021-09-30T17:55:12.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-10-10T16:09:40.000Z (over 4 years ago)
• Last Synced: 2025-06-25T13:55:22.257Z (12 months ago)
• Topics: email-sender, email-templates
• Language: TypeScript
• Homepage:
• Size: 358 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  

 



Mailframe




![Status](https://img.shields.io/badge/status-active-success.svg)

[![Version](https://img.shields.io/npm/v/@mailframe/mailframe.svg)](https://npmjs.org/package/@mailframe/cli)

[![License](https://img.shields.io/npm/l/@mailframe/mailframe)](https://github.com/pitops/mailframe/blob/main/package.json)

[![GitHub Issues](https://img.shields.io/github/issues/pitops/mailframe.svg)](https://github.com/pitops/mailframe/issues)

[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/pitops/mailframe.svg)](https://github.com/pitops/mailframe/pulls)



## 
💡 Small library that makes it super easy to manage and dispatch emails


## ✨ Features 

Mailframe is a small library that helps organize email templates, and easily dispatch emails with dynamic templating built-in retries, and more.

It was originally developed for use with [MessageRaft](https://github.com/messageraft/cli) but it can also be used without (check the custom dispatcher example)

- 🌈  [mustache.js](https://github.com/janl/mustache.js/) template syntax

- 💅  Automatic retries on **408, 413, 429, 500, 502, 503, 504** status codes (using  [ky](https://github.com/sindresorhus/ky))

- 📦 Automatic conversion of html to text and dispatch both

> [MessageRaft](https://github.com/messageraft/cli) needs to be setup separately if using the built-in method of dispatching emails

## 📦 Install

### Step 1 - Setup Messageraft

Follow the instructions found [here](https://github.com/messageraft/cli) to install and setup MessageRaft.

### Step 2 - Install Mailframe

```sh-session

$ npm install @mailframe/mailframe

OR

$ yarn add mailframe 

```

## 🔨 Usage

Please checkout the example [here](https://github.com/pitops/mailframe/tree/main/examples/default-usage) for usage.

### Custom dispatcher

In case you don't want to use MessageRaft and instead you prefer to use an email provider directly you can do that. Please check the example [here](https://github.com/pitops/mailframe/tree/main/examples/custom-dispatcher) for details

## 🤝 Contributions welcome