Посмотреть настройки почты

Возвращает список настроек корпоративной почты в организации.

Примечание

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

Запрос

GET https://cloud-api.yandex.ru/v1/admin/org/{org_id}/mail-settings

Path-параметры

Имя параметра	Тип	Описание
org_id *	integer	Идентификатор организации.

Заголовки

Authorization: OAuth <токен>

Пример

Пример запроса

curl -X GET "https://cloud-api.yandex.ru/v1/admin/org/7388248/mail-settings" -H "Authorization: <token>" -s

Ответ

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

Результатом корректного запроса является ответ с кодом 200 и телом в формате JSON, где содержится список настроек почты организации.

200 OK — запрос выполнен успешно.

Имя параметра	Тип	Описание
show_external_contact_notification_on_compose	boolean	Показывается ли предупреждение о том, что среди получателей создаваемых писем есть внешние контакты. Возможные значения: `true` — предупреждение показывается; `false` — предупреждение не показывается.
show_external_contact_notification_on_read	boolean	Показывается ли предупреждение о том, что среди отправителей входящих писем есть внешние контакты. Возможные значения: `true` — предупреждение показывается; `false` — предупреждение не показывается.
friendly_org_users_is_external	boolean	Приравниваются ли к внешним контактам сотрудники организаций, связанных с вашей организацией в федерацию. Возможные значения: `true` — сотрудники связанных организаций приравниваются к внешним контактам; `false` — сотрудники связанных организаций не приравниваются к внешним контактам.
lock_employees_default_mail_domain	boolean	Установлен ли запрет для сотрудников на переключение доменных и почтовых алиасов. При включенном запрете сотрудники не могут выбирать адрес отправителя для почтовых ящиков, которые имеют дополнительные адреса. Что такое алиасы Возможные значения: `true` — запрет на выбор адреса отправителя установлен; `false` — запрета на выбор адреса отправителя нет.
enable_imap	boolean	Разрешен ли: новым сотрудникам, аккаунты которых будут создаваться на домене организации — доступ к своим почтовым ящикам по протоколу IMAP; всем сотрудникам с почтой на домене организации — доступ к настройкам в Почте, которые регулируют работу с почтовым ящиком по протоколу IMAP. Возможные значения: `true` — доступы разрешены; `false` — доступы запрещены.
enable_pop	boolean	Разрешен ли: новым сотрудникам, аккаунты которых будут создаваться на домене организации — доступ к своим почтовым ящикам по протоколу POP3; всем сотрудникам с почтой на домене организации — доступ к настройкам в Почте, которые регулируют работу с почтовым ящиком по протоколу POP3. Возможные значения: `true` — доступы разрешены; `false` — доступы запрещены.
force_default_display_name	boolean	В разработке

Пример

Пример ответа

{
  "enable_imap": true,
  "enable_pop": true,
  "force_default_display_name": false,
  "friendly_org_users_is_external": true,
  "lock_employees_default_mail_domain": false,
  "show_external_contact_notification_on_compose": true,
  "show_external_contact_notification_on_read": true
}

Неуспешный ответ

Ошибки могут быть со следующими HTTP-статусами:

400 Bad Request — параметры запроса не заданы или заданы неверно;
401 Unauthorized — пользователь не авторизован;
403 Forbidden — у пользователя или приложения нет прав на доступ к настройкам почты;
404 Not Found — запрашиваемая организация не найдена;
500 Internal Server Error — ошибка произошла на стороне сервера (в этом случае попробуйте повторно отправить запрос через некоторое время).

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

Обзор

Изменить настройки