Skip to content

Latest commit

 

History

History
60 lines (48 loc) · 1.56 KB

README.md

File metadata and controls

60 lines (48 loc) · 1.56 KB

MailShine

MailShine is a web service that can perform post processing to emails you send from your application. It uses Premailer libraries, wrapped with a web API, and containerized in Docker container.

Installation

#####Clone the repository

git clone [email protected]:JANorman/MailShine.git
cd MailShine/

#####Build the docker container

docker build -t janorman/mailshine .

#####Run the container

docker run -p 45000:4567 -d janorman/mailshine

Congratulations, the application should now be running! Read the usage instructions for details on calling the APIs.

##Usage MailShine currently exposes the following endpoints

POST /mail

If you make a POST request to the /mail endpoint, the application will return you a JSON body, which contains the result of inlining the CSS in the body.

The requests body should be the full HTML body. An example request are response are below.

Outbound Request

curl -v -X POST -d "<html><head><style type="text/css">.test{ color: red; }</style></head><body><span class="test">Hi</span></body></html>" http://172.17.8.101:45000/mail

Response

< HTTP/1.1 200 OK
< Content-Type: application/json
< Content-Length: 184
< X-Content-Type-Options: nosniff
< Connection: keep-alive
< Server: thin

{
  "result":"<html><head></head><body><span class=\"test\" style=\"color: red;\">Hi</span></body></html>",
  "warnings":[
    {
      "message":"color CSS property",
      "level":"SAFE",
      "clients":"Eudora"
    }
  ]
}