2022-10-07 19:46:39 +13:00
|
|
|
# API v1
|
|
|
|
|
|
|
|
|
|
Mailpit provides a simple REST API to access and delete stored messages.
|
|
|
|
|
|
|
|
|
|
If the Mailpit server is set to use Basic Authentication, then API requests must use Basic Authentication too.
|
|
|
|
|
|
2023-03-31 17:29:04 +13:00
|
|
|
You can view the Swagger API documentation directly within Mailpit by going to `http://0.0.0.0:8025/api/v1/`.
|
|
|
|
|
|
2022-10-07 19:46:39 +13:00
|
|
|
The API is split into three main parts:
|
|
|
|
|
|
|
|
|
|
- [Messages](Messages.md) - Listing, deleting & marking messages as read/unread.
|
|
|
|
|
- [Message](Message.md) - Return message data & attachments
|
2022-11-13 16:45:54 +13:00
|
|
|
- [Tags](Tags.md) - Set message tags
|
2022-10-07 19:46:39 +13:00
|
|
|
- [Search](Search.md) - Searching messages
|
