mail

GET /v1/mail/services/{mailServiceId}/connection-settings

IMAP and SMTP settings for a mail client.

Всички крайни точки в mail

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението mail.view; ключ без него се отхвърля с 403, а не с 404.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/connection-settings \
  -H "Authorization: Bearer zdk_live_…"

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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_hoststringДа
imap_portintegerДа
imap_sslbooleanДа
smtp_hoststringДа
smtp_portintegerДа
smtp_starttlsbooleanДа

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 429 · 503