Просмотреть правила автоответа и пересылки

  1. HTTP-запрос
  2. Path-параметры
  3. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
      1. Представление
      2. Поля
    3. Код 403
      1. Представление
      2. Поля
    4. Код 404
      1. Представление
      2. Поля
    5. Код 500
      1. Представление
      2. Поля

Метод позволяет просмотреть правила автоответа и пересылки писем.

Ограничение. Чтобы выполнить запрос, приложению требуется разрешение на чтение настроек почты пользователя. Убедитесь, что вы включили его при настройке приложения на OAuth-сервере Яндекса.

HTTP-запрос

GET https://api360.yandex.net/admin/v1/org/{orgId}/mail/users/{userId}/settings/user_rules

Path-параметры

orgId *

integer

Идентификатор организации.

userId *

string

Идентификатор пользователя.

orgId *

integer

Идентификатор организации.

userId *

string

Идентификатор пользователя.

Ответы

Код 200

Запрос успешно выполнен.

{
  "autoreplies": [
    {
      "ruleId": integer,
      "ruleName": string,
      "text": string
    }
  ],
  "forwards": [
    {
      "address": string,
      "ruleId": integer,
      "ruleName": string,
      "withStore": boolean
    }
  ]
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

autoreplies[]

array

Правила автоответа.

autoreplies[].ruleId

integer

Идентификатор правила.

autoreplies[].ruleName

string

Название правила.

autoreplies[].text

string

Текст автоответа.

forwards[]

array

Правила автоматической пересылки.

forwards[].address

string

Email получателя пересылаемого письма.

forwards[].ruleId

integer

Идентификатор правила.

forwards[].ruleName

string

Название правила.

forwards[].withStore

boolean

Признак того, нужно ли сохранять копию письма в ящике исходного получателя.

autoreplies[]

array

Правила автоответа.

autoreplies[].ruleId

integer

Идентификатор правила.

autoreplies[].ruleName

string

Название правила.

autoreplies[].text

string

Текст автоответа.

forwards[]

array

Правила автоматической пересылки.

forwards[].address

string

Email получателя пересылаемого письма.

forwards[].ruleId

integer

Идентификатор правила.

forwards[].ruleName

string

Название правила.

forwards[].withStore

boolean

Признак того, нужно ли сохранять копию письма в ящике исходного получателя.

Код 401

Пользователь не авторизован.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 403

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 404

Запрашиваемый ресурс не найден.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 500

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string