diff --git a/REST.md b/REST.md new file mode 100644 index 0000000..1c0dc58 --- /dev/null +++ b/REST.md @@ -0,0 +1,20 @@ +# Inbucket REST API + +## GET /mailbox/{name} + +### Params + +* name: Name of the mailbox to list the contents of + +### Output + +A JSON array of message header maps, containing the following fields: +* Mailbox - name of the mailbox the message belongs to +* Id - message identifier, will be unique for this mailbox, but not across mailboxes +* From - message sender +* Subject - message subject line +* Date - date message was received (not the date specified by SMTP headers) in [ISO 8601][http://en.wikipedia.org/wiki/ISO_8601] format. +* Size - size of headers + message in bytes + +### Example +