Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 1.07 KB

APIv1.md

File metadata and controls

52 lines (30 loc) · 1.07 KB
Raw

MailHog API v1

The v1 API is a RESTful HTTP JSON API.

GET /api/v1/events

Streams new messages using EventSource and chunked encoding

GET /api/v1/messages

Lists all messages excluding message content

DELETE /api/v1/messages

Deletes all messages

Returns a 200 response code if message deletion was successful.

GET /api/v1/messages/{ message_id }

Returns an individual message including message content

DELETE /api/v1/messages/{ message_id }

Delete an individual message

Returns a 200 response code if message deletion was successful.

GET /api/v1/messages/{ message_id }/download

Download the complete message

GET /api/v1/messages/{ message_id }/mime/part/{ part_index }/download

Download a MIME part

POST /api/v1/messages/{ message_id }/release

Release the message to an SMTP server

Send a JSON body specifying the recipient, SMTP hostname and port number:

{
	"Host": "mail.example.com",
	"Post": "25",
	"Email": "[email protected]"
}

Returns a 200 response code if message delivery was successful.