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

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

Примечание

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

Request

GET

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

Path parameters

Name

Description

orgId*

Type: integer<int64>

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

userId*

Type: string<uint64>

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

Responses

200 OK

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

Body

application/json

{
    "autoreplies": [
        {
            "ruleId": 0,
            "ruleName": "string",
            "text": "string"
        }
    ],
    "forwards": [
        {
            "ruleId": 0,
            "ruleName": "string",
            "address": "string",
            "withStore": false
        }
    ]
}

Name

Description

autoreplies

Type: v1UserAutoreplyRule[]

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

forwards

Type: v1UserForwardRule[]

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

v1UserAutoreplyRule

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

v1UserForwardRule

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

401 Unauthorized

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

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: any[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

403 Forbidden

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

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: any[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

404 Not Found

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

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: any[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

500 Internal Server Error

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

Body

application/json

{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name	Description
code	Type: integer<int32> Код ошибки.
details	Type: any[] Дополнительные сведения об ошибке.
message	Type: string Описание ошибки.

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

Request

Path parameters

Responses

200 OK

Body

v1UserAutoreplyRule

v1UserForwardRule

401 Unauthorized

Body

403 Forbidden

Body

404 Not Found

Body

500 Internal Server Error

Body

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