Get Started
Usage API
More information

GET api/2.0/mail/messages This function requires authentication

Description

Returns the messages with the parameters specified in the request if there were changes since last check date.

Parameters
Name Description Type Example
folder
sent in url
Folder ID
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
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
sent in url
Page number
optional
number 1234
with_calendar
sent in url
Message has a calendar or not
optional
Bool value true
page_size
sent in url
Count of messages on page
optional
number 1234
user_folder_id
sent in url
User folder ID
optional
number 1234
sortorder
sent in url
Sort order by date: "ascending" - ascended, "descending" - descended string some text
Example
GET api/2.0/mail/messages?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

List of filtered messages