GET /v1/mail/services/{mailServiceId}/connection-settings
IMAP and SMTP settings for a mail client.
احراز هویت
یک کلید 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 زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول 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