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

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

Примечание

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

Request

GET

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

Path parameters

Name

Description

orgId

Type: integer

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

userId

Type: string<uint64>

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

Example: ``

Responses

200 OK

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

Body

application/json

{
  "autoreplies": [
    {
      "ruleId": 0,
      "ruleName": "example",
      "text": "example"
    }
  ],
  "forwards": [
    {
      "ruleId": 0,
      "ruleName": "example",
      "address": "example",
      "withStore": true
    }
  ]
}

Name

Description

autoreplies

Type: v1UserAutoreplyRule[]

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

Example

[
  {
    "ruleId": 0,
    "ruleName": "example",
    "text": "example"
  }
]

forwards

Type: v1UserForwardRule[]

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

Example

[
  {
    "ruleId": 0,
    "ruleName": "example",
    "address": "example",
    "withStore": true
  }
]

v1UserAutoreplyRule

Name	Description
ruleId	Type: integer Идентификатор правила.
ruleName	Type: string Название правила. Example: `example`
text	Type: string Текст автоответа. Example: `example`

Example

{
  "ruleId": 0,
  "ruleName": "example",
  "text": "example"
}

v1UserForwardRule

Name	Description
address	Type: string Email получателя пересылаемого письма. Example: `example`
ruleId	Type: integer Идентификатор правила.
ruleName	Type: string Название правила. Example: `example`
withStore	Type: boolean Признак того, нужно ли сохранять копию письма в ящике исходного получателя.

Example

{
  "ruleId": 0,
  "ruleName": "example",
  "address": "example",
  "withStore": true
}

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

protobufAny

Name

Description

@type

Type: string

Example: example

[additional]

Type: unknown

Example: null

Example

{
  "@type": "example"
}

401 Unauthorized

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

403 Forbidden

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

404 Not Found

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

500 Internal Server Error

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

Была ли статья полезна?

Изменить основной адрес и подписи

Создать правило автоответа или пересылки