mirror of
https://gitlab.com/ric_harvey/MailHog.git
synced 2024-11-23 22:34:04 +00:00
49 lines
1,019 B
Markdown
49 lines
1,019 B
Markdown
|
Go-MailHog API v1
|
||
|
|
=================
|
||
|
|
|
||
|
|
The v1 API is a RESTful HTTP JSON API.
|
||
|
|
|
||
|
|
### 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.
|