GitXplorerGitXplorer
t

misterzip

public
0 stars
0 forks
0 issues

Commits

List of commits on branch master.
Unverified
0a382d2300d5ead341e1a8e59da27a5e2644a776

add a little more to README

ttomjakubowski committed 12 years ago
Unverified
b6d7a5f7b46f024826b7dd07c0e7272d64ed680b

make the example use valid JSON :)

ttomjakubowski committed 12 years ago
Unverified
65c8ba5162c32d8899e478d733984979020b7dc5

add some brief docs to README

ttomjakubowski committed 12 years ago
Unverified
17c970ab47d4bbdec57d3bb205e1131a18633173

Initial commit

ttomjakubowski committed 12 years ago

README

The README file for this repository.

misterzip

misterzip provides a simple web API for sending email, e.g. for use with a site hosted on GitHub Pages.

Setup

misterzip is designed to run on Heroku and depends on the Sendgrid add-on. Besides the Sendgrid configuration variables, misterzip needs MISTERZIP_RECIPIENT set to the recipient email address.

API endpoint

The API is namespaced to /misterzip. For example, a letter delivery request is accessible at /misterzip/letter.

Letters API

Deliver a letter

POST /letter

Delivers an email to the configured recipient address.

Input

{
    "subject": "Greetings.",
    "message": "Hello, world!",
    "email": "dennis.ritchie@example.com",
    "name": "Dennis Ritchie"
}

Response

{
    "subject": "Greetings.",
    "message": "Hello, world!",
    "email": "dennis.ritchie@example.com",
    "name": "Dennis Ritchie"
}

TODO

  • reCAPTCHA support