mail

PUT `/v1/mail/mailboxes/{mailboxId}`

Change a mailbox's size, or its send/receive switches.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن mail.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X PUT https://api.zinndigital.com/v1/mail/mailboxes/{mailboxId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

Every field is optional; a request that sets only receive leaves the size alone. The size half is what makes the quota warning honest. mail.mailbox_quota_warning tells a customer their mailbox is filling up, and until this existed the only truthful advice it could give was "delete things" — the mail backend could always resize a mailbox, but nothing exposed it (#932, #662). quota_mb is bounded by the plan allowance captured on the service at purchase, so a later plan change cannot retroactively shrink what a customer was sold. Above that sits the backend package's own ceiling; both refusals answer 422 with the same customer-facing sentence, because the customer's next action is identical either way. Requires mail.manage.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`mailboxId (path)`	`Uuid`	نعم	Mailbox ID (UUIDv7).

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`quota_mb`	`integer`	لا	New mailbox size in MB. Capped by the plan allowance captured on the service, and above that by the backend package ceiling.
`send`	`boolean`	لا	Whether the mailbox may send.
`receive`	`boolean`	لا	Whether the mailbox may receive.

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`address`	`string`	نعم	The full address.
`local`	`string`	نعم	The part before the `@`.
`quota_mb`	`integer`	نعم	This mailbox's size in MB. `0` means no cap.
`used_mb`	`integer`	نعم	How much of it is used, as the mail backend last reported it (#932). Refreshed by the hourly reconcile, so it is a recent figure rather than a live one.
`percent_used`	`integer`	نعم	How full, 0-100. Always `0` for an uncapped mailbox — a percentage of "no limit" is meaningless, not zero-ish. Read `usage_checked_at` before showing it: this is also `0` for a…
`usage_checked_at`	`string`	لا	When the backend was last asked. `null` until the first sweep sees it.
`send_enabled`	`boolean`	نعم	—
`send_suspended_at`	`string`	لا	When we paused this mailbox's sending because most of its recent mail was permanently refused (W43-72). null = not paused.
`send_suspended_reason`	`string`	لا	The counts that decided the pause, in plain words. Empty when not paused.
`receive_enabled`	`boolean`	نعم	—
`status`	`MailboxStatus`	نعم	One mailbox's state.
`system_managed`	`boolean`	نعم	We created this mailbox when the domain was provisioned; the customer did not ask for it. It is the address the site itself sends from, so `deleteMailbox` and `renameMailbox`…
`created_at`	`string`	نعم	—

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 422 · 429 · 503

PUT /v1/mail/mailboxes/{mailboxId}