GET /v1/mail/services/{mailServiceId}/connection-settings
IMAP and SMTP settings for a mail client.
認証
ベアラー トークンとして API キーを送信します。キーには mail.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/connection-settings \
-H "Authorization: Bearer zdk_live_…"ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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