GET /v1/mail/services/{mailServiceId}/connection-settings
IMAP and SMTP settings for a mail client.
Authentication
Send an API key as a bearer token. The key must carry the mail.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/connection-settings \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
mailServiceId (path) | Uuid | Yes | Email service ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
imap_host | string | Yes | — |
imap_port | integer | Yes | — |
imap_ssl | boolean | Yes | — |
smtp_host | string | Yes | — |
smtp_port | integer | Yes | — |
smtp_starttls | boolean | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429 · 503