mail

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

IMAP and SMTP settings for a mail client.

Todos os endpoints de mail

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão mail.view; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

NomeTipoObrigatórioO que é
mailServiceId (path)UuidSimEmail service ID (UUIDv7).

Resposta

NomeTipoObrigatórioO que é
imap_hoststringSim
imap_portintegerSim
imap_sslbooleanSim
smtp_hoststringSim
smtp_portintegerSim
smtp_starttlsbooleanSim

Erros que este endpoint pode retornar

401 · 403 · 404 · 429 · 503