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

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

Для выполнения запроса требуются все перечисленные права: ya360_admin:mail_read_organization_settings и ya360_admin:mail_write_organization_settings.

Request

PATCH

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

Path parameters

Name

Description

org_id

Type: string

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

Example: 1234567

Body

application/json
{
  "enable_imap": true,
  "enable_pop": true,
  "disable_disk_attachments": 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,
  "force_default_display_name": false
}

Name

Description

disable_disk_attachments

Type: boolean

Установлен ли запрет на:

  • прикрепление к письмам файлов с Диска;
  • автоматическую загрузку вложений из письма на Диск.

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

  • true — запрет установлен;
  • false — запрета нет.

enable_imap

Type: boolean

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

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

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

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

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

enable_pop

Type: boolean

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

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

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

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

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

force_default_display_name

Type: boolean

Установить запрет для сотрудников на изменение отображаемого имени в интерфейсе Почты. При включенном запрете используется значение DisplayName из паспорта пользователя.

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

  • true — запрет на изменение имени установлен;
  • false — нет запрета на изменение имени.

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

friendly_org_users_is_external

Type: 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

Type: boolean

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

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

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

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

show_external_contact_notification_on_compose

Type: boolean

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

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

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

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

show_external_contact_notification_on_read

Type: boolean

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

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

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

Responses

200 OK

Настройки корпоративной почты организации обновлены.

Body

application/json
{
  "enable_imap": true,
  "enable_pop": true,
  "disable_disk_attachments": 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,
  "force_default_display_name": false
}

Name

Description

disable_disk_attachments

Type: boolean

Установлен ли запрет на:

  • прикрепление к письмам файлов с Диска;
  • автоматическую загрузку вложений из письма на Диск.

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

  • true — запрет установлен;
  • false — запрета нет.

enable_imap

Type: boolean

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

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

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

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

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

enable_pop

Type: boolean

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

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

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

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

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

force_default_display_name

Type: boolean

Установить запрет для сотрудников на изменение отображаемого имени в интерфейсе Почты. При включенном запрете используется значение DisplayName из паспорта пользователя.

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

  • true — запрет на изменение имени установлен;
  • false — нет запрета на изменение имени.

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

friendly_org_users_is_external

Type: 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

Type: boolean

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

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

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

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

show_external_contact_notification_on_compose

Type: boolean

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

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

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

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

show_external_contact_notification_on_read

Type: boolean

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

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

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

400 Bad Request

Параметры запроса не заданы или заданы неверно.

Body

application/json
{
  "error": "bad_request",
  "description": "Параметры запроса не заданы или заданы неверно.",
  "message": "Параметры запроса не заданы или заданы неверно.",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Параметры запроса не заданы или заданы неверно.

error

Type: string

Код ошибки

Example: bad_request

message

Type: string

Сообщение об ошибке.

Example: Параметры запроса не заданы или заданы неверно.

details
Type: object

Дополнительные детали ошибки

Example
{}

404 Not Found

Запрашиваемая организация не найдена.

Body

application/json
{
  "error": "not_found",
  "description": "Запрашиваемая организация не найдена.",
  "message": "Запрашиваемая организация не найдена.",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Запрашиваемая организация не найдена.

error

Type: string

Код ошибки

Example: not_found

message

Type: string

Сообщение об ошибке.

Example: Запрашиваемая организация не найдена.

details
Type: object

Дополнительные детали ошибки

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