@mailframe/mailframe v0.0.1

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

📝 Table of Contents

• About
• Getting Started

🧐 About

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 but it can also be used without (check the custom dispatcher example)

• mustache.js template syntax
• Automatic retries on 408, 413, 429, 500, 502, 503, 504 status codes (using ky)
• Automatic conversion of html to text and dispatch both

MessageRaft needs to be setup separately if using the built-in method of dispatching emails

🏁 Getting Started

Step 1 - Setup Messageraft

Follow the instructions found here to install and setup MessageRaft.

Step 2 - Install Mailframe

$ npm install @mailframe/mailframe

OR

$ yarn add mailframe 

Step 3 - Usage

Please checkout the example here for usage.

Step 3.1 - 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 for details

🤝 Contributions welcome