Get Started
Portal api methods
Help

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

Description

Get previous or next conversation id.

Parameters
Name Description Type Example
id
sent in url
Head message id of current conversation. number 1234
direction
sent in url
String parameter for determine prev or next conversation needed. "prev" for previous, "next" for next. string some text
folder
sent in url
Folder ID - integer. 1 - inbox, 2 - sent, 5 - spam.
optional
number 1234
unread
sent in url
Message unread status. bool flag. Search in unread(true), read(false) or all(null) messages.
optional
Bool value true
attachments
sent in url
Message attachments status. bool flag. Search messages with attachments(true), without attachments(false) or all(null) messages.
optional
Bool value true
period_from
sent in url
Begin search period date
optional
number 1234
period_to
sent in url
End search period date
optional
number 1234
important
sent in url
Message has importance flag. bool flag.
optional
Bool value true
from_address
sent in url
Address to find 'From' field
optional
string some text
to_address
sent in url
Address to find 'To' field
optional
string some text
mailbox_id
sent in url
Recipient mailbox id.
optional
number 1234
tags
sent in url
Messages tags. Id of tags linked with target messages.
optional
Collection of numbers
collection
1234
search
sent in url
Text to search in messages body and subject.
optional
string some text
page_size
sent in url
Count on messages on page
optional
number 1234
sortorder
sent in url
Sort order by date. String parameter: "ascending" - ascended, "descending" - descended. string some text
with_calendar
sent in url
Message has with_calendar flag. bool flag.
optional
Bool value true
user_folder_id
sent in url
id of user's folder
optional
number 1234
Example
GET api/2.0/mail/conversation/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

Head message id of previous or next conversation.