MailHog/APIv1.md

53 lines
1.1 KiB
Markdown
Raw Normal View History

2014-04-27 19:52:46 +00:00
Go-MailHog API v1
=================
The v1 API is a RESTful HTTP JSON API.
2014-04-28 00:58:45 +00:00
### GET /v1/api/events
Streams new messages using EventSource and chunked encoding
2014-04-27 19:52:46 +00:00
### GET /v1/api/messages
Lists all messages excluding message content
### DELETE /v1/api/messages
Deletes all messages
Returns a ```200``` response code if message deletion was successful.
### GET /v1/api/messages/{ message_id }
Returns an individual message including message content
### DELETE /v1/api/messages/{ message_id }
Delete an individual message
Returns a ```200``` response code if message deletion was successful.
### GET /v1/api/messages/{ message_id }/download
Download the complete message
### GET /v1/api/messages/{ message_id }/mime/part/{ part_index }/download
Download a MIME part
### POST /v1/api/messages/{ message_id }/release
Release the message to an SMTP server
Send a JSON body specifying the recipient, SMTP hostname and port number:
```json
{
"Host": "mail.example.com",
"Post": "25",
"Email": "someone@example.com"
}
```
Returns a ```200``` response code if message delivery was successful.