1
0
mirror of https://github.com/axllent/mailpit.git synced 2025-01-08 00:39:22 +02:00
mailpit/docs/apiv1
2023-10-25 10:01:03 +13:00
..
Message.md Remove redundant Read status from message (always true) 2023-09-22 21:31:35 +12:00
Messages.md Update API documentation 2023-07-12 17:30:03 +12:00
README.md Docs: Update documentation links 2023-10-25 10:01:03 +13:00
Search.md Update API documentation 2023-07-12 17:30:03 +12:00
Tags.md Feature: Message tags and auto-tagging 2022-11-13 17:26:29 +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.

You can view the Swagger API documentation directly within Mailpit by going to https://mailpit.axllent.org/docs/api-v1/.

The API is split into four main parts:

  • Messages - Listing, deleting & marking messages as read/unread.
  • Message - Return message data & attachments
  • Tags - Set message tags
  • Search - Searching messages