go/mailpit
1
0
Fork 0
mirror of https://github.com/axllent/mailpit.git synced 2025-08-15 20:13:16 +02:00
Code Issues Releases Activity

Update API documentation

Browse Source
This commit is contained in:
Ralph Slooten
2023-07-12 17:30:03 +12:00
parent b8de57da27
commit aeb3585f3e
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/apiv1/Messages.md
View File

@@ -29,7 +29,7 @@ List messages in the mailbox. Messages are returned in the order of latest recei
{ {
"total": 500, "total": 500,
"unread": 500, "unread": 500,
"count": 50, "messages_count": 50,
"start": 0, "start": 0,
"tags": ["test"], "tags": ["test"],
"messages": [ "messages": [
@@ -69,7 +69,7 @@ List messages in the mailbox. Messages are returned in the order of latest recei
- `total` - Total messages in mailbox - `total` - Total messages in mailbox
- `unread` - Total unread messages in mailbox - `unread` - Total unread messages in mailbox
- `count` - Number of messages returned in request - `messages_count` - Total number of messages in mailbox
- `start` - The offset (default `0`) for pagination - `start` - The offset (default `0`) for pagination
- `Read` - The read/unread status of the message - `Read` - The read/unread status of the message
- `From` - Name & Address, or null if none - `From` - Name & Address, or null if none

4
docs/apiv1/Search.md
View File

@@ -25,7 +25,7 @@ Matching messages are returned in the order of latest received to oldest.
{ {
"total": 500, "total": 500,
"unread": 500, "unread": 500,
"count": 25, "messages_count": 25,
"start": 0, "start": 0,
"messages": [ "messages": [
{ {
@@ -63,7 +63,7 @@ Matching messages are returned in the order of latest received to oldest.
- `total` - Total messages in mailbox (all messages, not search) - `total` - Total messages in mailbox (all messages, not search)
- `unread` - Total unread messages in mailbox (all messages, not search) - `unread` - Total unread messages in mailbox (all messages, not search)
- `count` - Number of messages returned in request - `messages_count` - Total number of messages matching search
- `start` - The offset (default `0`) for pagination - `start` - The offset (default `0`) for pagination
- `From` - Singular Name & Address, or null if none - `From` - Singular Name & Address, or null if none
- `To`, `CC`, `BCC` - Array of Name & Address - `To`, `CC`, `BCC` - Array of Name & Address