Действия с письмами

API 0.16.0OpenAPIllms-full.txt

POST/v1/mailboxes/{mailbox_id}/messages/actions

Применяет действие к выбранным письмам одной папки. Передайте их идентификаторы в uids, имя папки в folder и её uidvalidity. Для action=move также укажите целевую папку в destination.

Авторизация и области доступа · Ошибки и повторы

Запрос

curl -X POST 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>/messages/actions' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  --data '{"folder":"INBOX","uidvalidity":1,"uids":[1],"action":"read"}'

Параметры

mailbox_idpathОбязательно

integer

X-Customer-IDheader

Вариант 1

string

Вариант 2

null

Тело запроса · application/json

object

folderОбязательно

string

Имя папки из списка папок, например INBOX.

minLength: 1

maxLength: 255

uidvalidityОбязательно

integer

Значение uidvalidity из ответа API для этой папки.

exclusiveMinimum: 0

uidsОбязательно

array

Идентификаторы выбранных писем из одной папки.

minItems: 1

maxItems: 100

Элементы массива

integer

actionОбязательно

string

Допустимые значения: "read" "unread" "star" "unstar" "move" "delete"

destination

Имя целевой папки. Обязательно для action=move.

Вариант 1

string

maxLength: 255

Вариант 2

null

Неизвестные поля не принимаются.

Ответы

200 Успешный ответ

application/json

object

updated

boolean

401 Требуется вход

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

403 Нет доступа

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

404 Ресурс не найден

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

409 Конфликт состояния

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object

422 Ошибка валидации

application/json

object

detail

array

Элементы массива

object

locОбязательно

array

Элементы массива

Вариант 1

string

Вариант 2

integer

msgОбязательно

string

typeОбязательно

string

503 Временная недоступность

application/json

object

detail

Вариант 1

string

Вариант 2

object

code

string

message

string

Вариант 3

array

Элементы массива

object