1
0
mirror of https://github.com/jhillyerd/inbucket.git synced 2025-12-21 11:37:07 +00:00

Created REST (markdown)

James Hillyerd
2013-10-15 16:34:02 -07:00
parent 79cd8b9522
commit ce0f74cbba

20
REST.md Normal file

@@ -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