GET api/2.0/mail/messages/{id}/{direction} This function requires authentication

Description

Returns the previous or next message ID filtered with the parameters specified in the request.

Parameters
Name Description Type Example
id
sent in url
Head message ID of the current conversation number 1234
direction
sent in url
Defines if the previous or next message is needed: "prev" for previous, "next" for next string some text
folder
sent in url
Folder type: 1 - inbox, 2 - sent, 5 - spam
optional
number 1234
unread
sent in url
Message status: unread (true), read (false), or all (null) messages
optional
Bool value true
attachments
sent in url
Defines if a message has attachments or not: with attachments (true), without attachments (false), or all (null) messages
optional
Bool value true
period_from
sent in url
Start search period date
optional
number 1234
period_to
sent in url
End search period date
optional
number 1234
important
sent in url
Specifies if only important messages will be displayed or not
optional
Bool value true
from_address
sent in url
Mail address from which a letter was received
optional
string some text
to_address
sent in url
Mail address to which a letter was sent
optional
string some text
mailbox_id
sent in url
Recipient mailbox ID
optional
number 1234
tags
sent in url
IDs of tags linked to the target message
optional
Collection of numbers
collection
1234
search
sent in url
Text to search in the message bodies and subjects
optional
string some text
page_size
sent in url
Number of messages on the page
optional
number 1234
sortorder
sent in url
Sort order by date: "ascending" or "descending"
optional
string some text
with_calendar
sent in url
Specifies if the messages have a calendar or not
optional
Bool value true
user_folder_id
sent in url
User folder ID
optional
number 1234
Example
GET api/2.0/mail/messages/1234/%22some+text%22?folder=1234&unread=true&attachments=true&period_from=1234&period_to=1234&important=true&from_address=%22some+text%22&to_address=%22some+text%22&mailbox_id=1234&tags=%5b%0d%0a++1234%0d%0a%5d&search=%22some+text%22&page_size=1234&sortorder=%22some+text%22&with_calendar=true&user_folder_id=1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Previous or next message ID