GET api/2.0/mail/messages
Данная функция требует аутентификации
Описание
Возвращает сообщения с параметрами, указанными в запросе, если с момента последней проверки произошли изменения.
Параметры
Название | Описание | Тип | Пример |
folder sent in url | ID папки необязательно | численный | 1234 |
unread sent in url | Статус сообщения: непрочитанные (true), прочитанные (false) или все (null) сообщения необязательно | логический | true |
attachments sent in url | Определяет, имеет ли сообщение вложения или нет: с вложениями (true), без вложений (false) или все сообщения (null). необязательно | логический | true |
period_from sent in url | Дата начала периода поиска необязательно | численный | 1234 |
period_to sent in url | Дата окончания периода поиска необязательно | численный | 1234 |
important sent in url | Важное сообщение или нет необязательно | логический | true |
from_address sent in url | Почтовый адрес, с которого пришло письмо необязательно | строковый | текст |
to_address sent in url | Почтовый адрес, на который пришло письмо необязательно | строковый | текст |
mailbox_id sent in url | Идентификатор почтового ящика получателя необязательно | численный | 1234 |
tags sent in url | Идентификаторы тегов, связанных с целевым сообщением необязательно | Collection of numbers collection | 1234 |
search sent in url | Текст для поиска в теле и теме сообщения необязательно | строковый | текст |
page sent in url | Номер страницы необязательно | численный | 1234 |
with_calendar sent in url | Есть ли в сообщении календарь или нет необязательно | логический | true |
page_size sent in url | Количество сообщений на странице необязательно | численный | 1234 |
user_folder_id sent in url | Идентификатор папки пользователя необязательно | численный | 1234 |
sortorder sent in url | Порядок сортировки по дате: «по возрастанию» — по возрастанию, «по убыванию» — по убыванию | строковый | текст |
Пример
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.Р7.com Content-Type: application/json Accept: application/json
Возвращает
Список отфильтрованных сообщений
Список отфильтрованных сообщений