---
title: "Получить подсказки почтовых провайдеров"
method: GET
path: "/api/v1/mail/providers"
tags: ["Mail accounts"]
---

# Получить подсказки почтовых провайдеров

`GET /api/v1/mail/providers`

## Request

- Base URL: `https://erp.akeda.ru`
- URL: `https://erp.akeda.ru/api/v1/mail/providers`
- 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`)

Каталог известных провайдеров с хостами, портами и указанием, какой именно пароль нужен. Список — подсказка, а не ограничение: любой ящик подключается вручную. Параметр email добавляет к ответу поле suggestion с подсказкой по домену адреса; неизвестный домен просто не даёт suggestion.

## Query parameters

- `email` string

## Headers

- `X-Tenant` string, required

## Response `200`

Каталог провайдеров и подсказка по адресу

- object
  - `items` MailProvider[], required
    - `key` string, required: Машинный ключ провайдера
    - `label` string, required: Название провайдера для человека
    - `domains` string[], required: Домены адресов, по которым подсказка подбирается
    - `imap_host` string, required
    - `imap_port` integer, required
    - `imap_encryption` 'tls' | 'starttls', required: Режим шифрования канала. Открытого соединения без TLS в перечне нет намеренно: пароль от почты в открытом канале не передаётся.
    - `smtp_host` string, required
    - `smtp_port` integer, required
    - `smtp_encryption` 'tls' | 'starttls', required: Режим шифрования канала. Открытого соединения без TLS в перечне нет намеренно: пароль от почты в открытом канале не передаётся.
    - `password_hint` string, required: Какой именно пароль нужен: у перечисленных провайдеров обычный пароль от аккаунта не подходит
    - `help_url` string, required: Ссылка на справку провайдера; у части провайдеров пуста
  - `suggestion` MailProvider: Подсказка настроек для формы подключения ящика
    - `key` string, required: Машинный ключ провайдера
    - `label` string, required: Название провайдера для человека
    - `domains` string[], required: Домены адресов, по которым подсказка подбирается
    - `imap_host` string, required
    - `imap_port` integer, required
    - `imap_encryption` 'tls' | 'starttls', required: Режим шифрования канала. Открытого соединения без TLS в перечне нет намеренно: пароль от почты в открытом канале не передаётся.
    - `smtp_host` string, required
    - `smtp_port` integer, required
    - `smtp_encryption` 'tls' | 'starttls', required: Режим шифрования канала. Открытого соединения без TLS в перечне нет намеренно: пароль от почты в открытом канале не передаётся.
    - `password_hint` string, required: Какой именно пароль нужен: у перечисленных провайдеров обычный пароль от аккаунта не подходит
    - `help_url` string, required: Ссылка на справку провайдера; у части провайдеров пуста

## Other responses

- `401`: Сессия, ключ или кабинет не подтверждены
- `403`: Текущая роль не имеет требуемого права

---

[API](https://skmtc.dev/akeda/apis/akeda-erp-client-api.md) · [All operations](https://skmtc.dev/akeda/apis/akeda-erp-client-api/llms.txt) · [OpenAPI document](https://skmtc.dev/akeda/apis/akeda-erp-client-api/revisions/3c60ded179f2?raw)