mail

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

IMAP and SMTP settings for a mail client.

Tutti gli endpoint mail

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione mail.view; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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`.

Parametri

NomeTipoObbligatorioChe cos'è
mailServiceId (path)UuidEmail service ID (UUIDv7).

Risposta

NomeTipoObbligatorioChe cos'è
imap_hoststring
imap_portinteger
imap_sslboolean
smtp_hoststring
smtp_portinteger
smtp_starttlsboolean

Errori che questo endpoint può restituire

401 · 403 · 404 · 429 · 503