GET /v1/mail/services/{mailServiceId}/connection-settings
IMAP and SMTP settings for a mail client.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение mail.view; ключ без него отклоняется с кодом 403, а не 404.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/connection-settings \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
The hostnames and ports a customer types into Apple Mail, Outlook or a phone. For Zinn®'s own email these are **our** hostnames — an environment that has not been given them returns `503` rather than inventing names or naming the backend. For a `custom` provider they are the declared ones, and a declaration with no client hostnames is a `422` that says to ask the provider rather than an invented name. A `zinn` service under a white-label account is also `422`: our hostnames must not reach a reseller's client (W40-MAIL). Requires `mail.view`.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
mailServiceId (path) | Uuid | Да | Email service ID (UUIDv7). |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
imap_host | string | Да | — |
imap_port | integer | Да | — |
imap_ssl | boolean | Да | — |
smtp_host | string | Да | — |
smtp_port | integer | Да | — |
smtp_starttls | boolean | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 429 · 503