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

Updated REST (markdown)

James Hillyerd
2013-10-15 16:41:07 -07:00
parent ce0f74cbba
commit 4a9d61ddaf

40
REST.md

@@ -13,8 +13,46 @@ A JSON array of message header maps, containing the following fields:
* 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.
* 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
Request: `GET /mailbox/swaks`
Response:
[
{
"Mailbox":"swaks",
"Id":"20131015T161202-0000",
"From":"jamehi03@server.com",
"Subject":"Swaks Plain Text",
"Date":"2013-10-15T16:12:02.231532239-07:00",
"Size":264
},
{
"Mailbox":"swaks",
"Id":"20131015T161202-0001",
"From":"jamehi03@server.com",
"Subject":"Swaks HTML",
"Date":"2013-10-15T16:12:02.292145012-07:00",
"Size":705
},
{
"Mailbox":"swaks",
"Id":"20131015T161202-0002",
"From":"jamehi03@server.com",
"Subject":"Swaks Attachment",
"Date":"2013-10-15T16:12:02.358027334-07:00",
"Size":4802
},
{
"Mailbox":"swaks",
"Id":"20131015T161202-0003",
"From":"jamehi03@server.com",
"Subject":"Test of ȇɲʢȯȡɪɴʛ",
"Date":"2013-10-15T16:12:02.424206527-07:00",
"Size":2946
}
]