ric/MailHog
1
0
Fork 0
mirror of https://gitlab.com/ric_harvey/MailHog.git synced 2024-12-17 18:07:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
MailHog/docs/APIv1.md
Ian Kent f6a0924e8d Move stuff around
2014-12-24 18:34:24 +00:00

1.1 KiB
Raw Blame History

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": "someone@example.com"
}

Returns a 200 response code if message delivery was successful.