From 42e6d71415aea6d293a8e592dd1b31a812c1d2fe Mon Sep 17 00:00:00 2001 From: Ralph Slooten Date: Wed, 31 May 2023 08:20:05 +1200 Subject: [PATCH] Update API docs --- docs/apiv1/Message.md | 2 ++ docs/apiv1/Messages.md | 3 +++ docs/apiv1/Search.md | 1 + 3 files changed, 6 insertions(+) diff --git a/docs/apiv1/Message.md b/docs/apiv1/Message.md index d40c36e..28f14eb 100644 --- a/docs/apiv1/Message.md +++ b/docs/apiv1/Message.md @@ -15,6 +15,7 @@ Returns a JSON summary of the message and attachments. ```json { "ID": "d7a5543b-96dd-478b-9b60-2b465c9884de", + "MessageID": "12345.67890@localhost", "Read": true, "From": { "Name": "John Doe", @@ -31,6 +32,7 @@ Returns a JSON summary of the message and attachments. "ReplyTo": [], "Subject": "Message subject", "Date": "2016-09-07T16:46:00+13:00", + "Tags": ["test"], "Text": "Plain text MIME part of the email", "HTML": "HTML MIME part (if exists)", "Size": 79499, diff --git a/docs/apiv1/Messages.md b/docs/apiv1/Messages.md index 9d72129..709f9c5 100644 --- a/docs/apiv1/Messages.md +++ b/docs/apiv1/Messages.md @@ -31,9 +31,11 @@ List messages in the mailbox. Messages are returned in the order of latest recei "unread": 500, "count": 50, "start": 0, + "tags": ["test"], "messages": [ { "ID": "1c575821-70ba-466f-8cee-2e1cf0fcdd0f", + "MessageID": "12345.67890@localhost", "Read": false, "From": { "Name": "John Doe", @@ -54,6 +56,7 @@ List messages in the mailbox. Messages are returned in the order of latest recei "Bcc": [], "Subject": "Message subject", "Created": "2022-10-03T21:35:32.228605299+13:00", + "Tags": ["test"], "Size": 6144, "Attachments": 0 }, diff --git a/docs/apiv1/Search.md b/docs/apiv1/Search.md index fdf6d02..038e55f 100644 --- a/docs/apiv1/Search.md +++ b/docs/apiv1/Search.md @@ -30,6 +30,7 @@ Matching messages are returned in the order of latest received to oldest. "messages": [ { "ID": "1c575821-70ba-466f-8cee-2e1cf0fcdd0f", + "MessageID": "12345.67890@localhost", "Read": false, "From": { "Name": "John Doe",