go/mailpit
1
0
Fork 0
mirror of https://github.com/axllent/mailpit.git synced 2024-12-30 23:17:59 +02:00
Code Issues Releases Activity
c4a695e627
mailpit/docs/apiv1
History
Ralph Slooten 5350e2eb08 Feature: OpenAPI / Swagger schema 
Mailpit now has built-in OpenAPI / Swagger documentation, see #65
2023-03-31 18:44:08 +13:00
..
Message.md Bugfix: Return empty arrays rather than null for message To, CC, BCC, Inlines & Attachments 2022-11-13 17:26:17 +13:00
Messages.md Bugfix: Return empty arrays rather than null for message To, CC, BCC, Inlines & Attachments 2022-11-13 17:26:17 +13:00
README.md Feature: OpenAPI / Swagger schema 2023-03-31 18:44:08 +13:00
Search.md Bugfix: Return empty arrays rather than null for message To, CC, BCC, Inlines & Attachments 2022-11-13 17:26:17 +13:00
Tags.md Feature: Message tags and auto-tagging 2022-11-13 17:26:29 +13:00

README.md

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 http://0.0.0.0:8025/api/v1/.

The API is split into three main parts:

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