Get Started
Portal api methods
Help

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

Description

Returns the filtered messages in case 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 unread status
optional
Bool value true
attachments
sent in url
Message with attachments status
optional
Bool value true
period_from
sent in url
Period start date
optional
number 1234
period_to
sent in url
Period end date
optional
number 1234
important
sent in url
Message with importance 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
Message tags
optional
Collection of numbers
collection
1234
search
sent in url
Text to search in messages
optional
string some text
page
sent in url
Page number
optional
number 1234
with_calendar
sent in url
Message has calendar flag. bool flag.
optional
Bool value true
page_size
sent in url
Number of messages on page
optional
number 1234
user_folder_id
sent in url
id of user's folder
optional
number 1234
sortorder
sent in url
Sort order 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

Messages list