ric/MailHog
1
0
Fork 0
mirror of https://gitlab.com/ric_harvey/MailHog.git synced 2024-11-27 16:24:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #17 from geerlingguy/fix-api-docs

Browse source 
Update docs to refer to correct /api/v1 URL.
This commit is contained in:
Ian Kent 2014-12-17 19:11:05 +00:00
commit 254603deb9
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
APIv1.md
View file

@ -3,39 +3,39 @@ Go-MailHog API v1
The v1 API is a RESTful HTTP JSON API. The v1 API is a RESTful HTTP JSON API.
### GET /v1/api/events ### GET /api/v1/events
Streams new messages using EventSource and chunked encoding Streams new messages using EventSource and chunked encoding
### GET /v1/api/messages ### GET /api/v1/messages
Lists all messages excluding message content Lists all messages excluding message content
### DELETE /v1/api/messages ### DELETE /api/v1/messages
Deletes all messages Deletes all messages
Returns a ```200``` response code if message deletion was successful. Returns a ```200``` response code if message deletion was successful.
### GET /v1/api/messages/{ message_id } ### GET /api/v1/messages/{ message_id }
Returns an individual message including message content Returns an individual message including message content
### DELETE /v1/api/messages/{ message_id } ### DELETE /api/v1/messages/{ message_id }
Delete an individual message Delete an individual message
Returns a ```200``` response code if message deletion was successful. Returns a ```200``` response code if message deletion was successful.
### GET /v1/api/messages/{ message_id }/download ### GET /api/v1/messages/{ message_id }/download
Download the complete message Download the complete message
### GET /v1/api/messages/{ message_id }/mime/part/{ part_index }/download ### GET /api/v1/messages/{ message_id }/mime/part/{ part_index }/download
Download a MIME part Download a MIME part
### POST /v1/api/messages/{ message_id }/release ### POST /api/v1/messages/{ message_id }/release
Release the message to an SMTP server Release the message to an SMTP server