GET /v1/mail/services/{mailServiceId}/connection-settings
IMAP and SMTP settings for a mail client.
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền mail.view; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.
Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/connection-settings \
-H "Authorization: Bearer zdk_live_…"Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
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.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
mailServiceId (path) | Uuid | Có | Email service ID (UUIDv7). |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
imap_host | string | Có | — |
imap_port | integer | Có | — |
imap_ssl | boolean | Có | — |
smtp_host | string | Có | — |
smtp_port | integer | Có | — |
smtp_starttls | boolean | Có | — |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 429 · 503