Skip to content

moveyourdigital/bootstrap-email-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bootstrap Email Transpiler REST API

A Ruby dockerized service that receives a Bootstrap Email payload and returns an HTML 3.0 responsive tabled layout that works for the following email clients:

  • Apple Mail macOS
  • Apple Mail iOS
  • Outlook 2000 - 2003 (IE Render)
  • Outlook 2007 - 2013 (MS Word Render)
  • Outlook 2016
  • Outlook.com (the new Hotmail)
  • Windows 10 Mail
  • Yahoo!
  • AOL Mail
  • Android Mail
  • Gmail
  • Gmail App
  • Inbox by Gmail
  • Modern Email Clients
  • Any many more...

Usage

  1. Pull docker image
docker pull moveyourdigital/bootstrap-email-api
  1. Run a container
docker run -p 9292:9292 moveyourdigital/bootstrap-email-api
  1. Test using curl
curl -XPOST -H "Content-Type: application/json" http://127.0.0.1:9292/ -d '{"html": "<a href=\"#\" class=\"btn btn-primary\">Button</a>"}'

An HTML 3.0 should be returned.

Endpoints

HTML

curl -XPOST -H "Content-Type: application/json" http://127.0.0.1:9292/html -d '{"html": "<a href=\"#\" class=\"btn btn-primary\">Button</a>"}'

Plain text

curl -XPOST -H "Content-Type: application/json" http://127.0.0.1:9292/plaintext -d '{"html": "<a href=\"#\" class=\"btn btn-primary\">Button</a>"}'

Multipart

curl -XPOST -H "Content-Type: application/json" http://127.0.0.1:9292/multipart -d '{"html": "<a href=\"#\" class=\"btn btn-primary\">Button</a>"}'

Options

scss

Optional SASS variables to customize colors, sizes, etc, can be passed as a string:

curl -XPOST -H "Content-Type: application/json" http://127.0.0.1:9292/ -d '{"html": "<a href=\"#\" class=\"btn btn-primary\">Button</a>", "scss": "$primary: #000000;"}'

Stack:

  • ruby (3.2)
  • rack (2.2)
  • puma (6.3)
  • hanami-api (0.3)
  • bootstrap-email (1.4.0)

About

Bootstrap Email Transpiler REST API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published