Get Started
Usage API
More information

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 current conversation number 1234
direction
sent in url
Defines if the previous or next conversation 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 conversation 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
Important message or not
optional
Bool value true
from_address
sent in url
Mail address from which a letter came
optional
string some text
to_address
sent in url
Mail address to which a letter came
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 message body and subject
optional
string some text
page_size
sent in url
Count of messages on page
optional
number 1234
sortorder
sent in url
Sort order by date: "ascending" - ascended, "descending" - descended
optional
string some text
with_calendar
sent in url
Message has 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/some+text?from_address=some+text&to_address=some+text&tags=%5b1234%5d&search=some+text&sortorder=some+text
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Previous or next message ID