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

Метод обновляет настройки корпоративной почты в организации. Обновляются только те настройки, которые отправлены в запросе.

Примечание

Чтобы выполнить запрос, OAuth-приложению требуются разрешения:

  • ya360_admin:mail_read_organization_settings — чтение настроек почты организации;
  • ya360_admin:mail_write_organization_setting — управление настройками почты организации.

Запрос

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

Path-параметры

Имя параметра

Тип

Описание

org_id *

integer

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

Заголовки

Authorization: OAuth <токен>
Content-Type: application/json

Тело

Имя параметра

Тип

Описание

show_external_contact_notification_on_compose

boolean

Предупреждать ли о том, что среди получателей создаваемых писем есть внешние контакты.

Возможные значения:

  • true — показывать предупреждение;
  • false — не показывать предупреждение.

Значение по умолчанию — true.

show_external_contact_notification_on_read

boolean

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

Возможные значения:

  • true — показывать предупреждение;
  • false — не показывать предупреждение.

Значение по умолчанию — false.

friendly_org_users_is_external

boolean

Приравнивать ли к внешним контактам сотрудников организаций, связанных с вашей организацией в федерацию.

Возможные значения:

  • true — сотрудники связанных организаций приравниваются к внешним контактам и будут помечаться при включении настройки show_external_contact_notification_on_compose или show_external_contact_notification_on_read;
  • false — сотрудники связанных организаций не помечаются вне зависимости от настроек show_external_contact_notification_on_compose или show_external_contact_notification_on_read.

Значение по умолчанию — false.

lock_employees_default_mail_domain

boolean

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

Возможные значения:

  • true — запрет на выбор адреса отправителя установлен;
  • false — запрета на выбор адреса отправителя нет.

Значение по умолчанию — false.

enable_imap

boolean

Разрешить ли:

  • новым сотрудникам, аккаунты которых будут создаваться на домене организации — доступ к своим почтовым ящикам по протоколу IMAP;
  • всем сотрудникам с почтой на домене организации — доступ к настройкам в Почте, которые регулируют работу с почтовым ящиком по протоколу IMAP.

Возможные значения:

  • true — доступы разрешены;
  • false — доступы запрещены.

Значение по умолчанию — true.

enable_pop

boolean

Разрешить ли:

  • новым сотрудникам, аккаунты которых будут создаваться на домене организации — доступ к своим почтовым ящикам по протоколу POP3;
  • всем сотрудникам с почтой на домене организации — доступ к настройкам в Почте, которые регулируют работу с почтовым ящиком по протоколу POP3.

Возможные значения:

  • true — доступы разрешены;
  • false — доступы запрещены.

Значение по умолчанию — true.

Пример

Изменить параметры, которые отвечают за показ предупреждений о внешних контактах в Почте
$ curl -s -X PATCH "https://cloud-api.yandex.ru/v1/admin/org/1234567/mail-settings" \
> -H "Authorization: <token>" \
> -H "Content-Type: application/json" \
> -d '
> {
>   "show_external_contact_notification_on_compose": true,
>   "show_external_contact_notification_on_read": true,
>   "friendly_org_users_is_external": true
> }
> '

Результат выполнения запроса

При просмотре входящих писем и при создании новых Почта будет предупреждать, что среди отправителей или получателей есть внешние контакты или сотрудники связанных организаций.
Запретить новым сотрудникам работу с почтовым ящикам через почтовые программы
$ curl -s -X PATCH "https://cloud-api.yandex.ru/v1/admin/org/1234567/mail-settings" \
> -H "Authorization: <token>" \
> -H "Content-Type: application/json" \
> -d '
> {
>   "enable_imap": false,
>   "enable_pop": false
> }
> '

Результат выполнения запроса

Будут запрещены:

  • новым сотрудникам, аккаунты которых будут создаваться на домене организации — доступы к почтовым ящикам по протоколам IMAP и POP3;
  • всем сотрудникам с почтой на домене организации — доступ к настройкам в Почте, которые регулируют работу с почтовым ящиком по протоколам IMAP и POP3.

Ответ

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

Результатом корректного запроса является ответ с кодом 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 — ошибка произошла на стороне сервера (в этом случае попробуйте повторно отправить запрос через некоторое время).

Пользователи не из вашей организации.

Предыдущая
Просмотреть настройки
Следующая
Обзор