Mail accounts

Получить почтовый ящик

Недоступный и отсутствующий ящик одинаково возвращают 404: иначе перебором идентификаторов составляется карта чужих ящиков кабинета.

get/api/v1/mail/accounts/{id}

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/mail/accounts/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://erp.akeda.ru/oauth2/authorize, token URL https://erp.akeda.ru/oauth2/token, scopes: akeda:delegate)

Response

Ящик без учётных данных

idstring uuid required
owner_user_idinteger required

Сотрудник, которому принадлежит ящик

sharedboolean required

Общий ящик виден каждому сотруднику кабинета с правом mail:read (или участникам бизнеса business_id); личный — владельцу и поимённо названным в shared_with. Право видеть все записи чтения чужого ящика не даёт

business_idstring uuid required
shared_withinteger[] required

Сотрудники, которым ящик открыт поимённо, поверх правила access_scope. Всегда список: пустой — поимённо никому

access_scope'personal' | 'users' | 'cabinet' | 'business' required

Кому виден ящик кроме владельца: personal — никому; users — только сотрудникам из shared_with; cabinet — каждому сотруднику кабинета с mail:read; business — сотрудникам с mail:read, чья область касается business_id

emailstring required
display_namestring required
notification_mode'all' | 'important' | 'off' required

Уведомления владельца ящика о новой почте: все письма, только важные отправители или выключено

imap_hoststring required
imap_portinteger required
imap_encryption'tls' | 'starttls' required

Режим шифрования канала. Открытого соединения без TLS в перечне нет намеренно: пароль от почты в открытом канале не передаётся.

smtp_hoststring required
smtp_portinteger required
smtp_encryption'tls' | 'starttls' required

Режим шифрования канала. Открытого соединения без TLS в перечне нет намеренно: пароль от почты в открытом канале не передаётся.

usernamestring required

Логин подключения; по умолчанию равен адресу

has_credentialsboolean required

Пароль приложения сохранён. Самого пароля не отдаёт ни одна операция

status'active' | 'disabled' | 'error' required

Состояние ящика. disabled ставит человек, error — воркер синхронизации; разделение нужно, чтобы починка пароля не воскрешала ящик, который владелец выключил сознательно.

sync_status'never' | 'ok' | 'running' | 'failed' required

Состояние последней синхронизации ящика

sync_since_daysinteger required

Глубина первичного импорта в днях; ноль означает весь ящик

signaturestring required

Подпись, подставляемая в исходящие письма

last_sync_atstring date-time nullable required
last_errorstring required

Последняя ошибка подключения для человека

last_error_codestring required

Машинный код последней ошибки подключения, например mail.account.credentials_rejected; пусто, когда ошибки нет

unread_countinteger required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.