mail

PUT /v1/mail/mailboxes/{mailboxId}

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

Të gjitha pikat e skajshme mail

Autentifikimi

Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen mail.manage; një çelës pa të refuzohet me 403, jo 404.

Ky pikëndalim nuk pranon id të organizatës. Çelësi juaj tashmë identifikon organizatën së cilës i përket dhe përgjigjja kufizohet vetëm për atë.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

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

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

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

Parametrat

EmriLlojiKërkohetÇfarë është kjo
mailboxId (path)UuidPoMailbox ID (UUIDv7).

Trupi i kërkesës

EmriLlojiKërkohetÇfarë është kjo
quota_mbintegerJoNew mailbox size in MB. Capped by the plan allowance captured on the service, and above that by the backend package ceiling.
sendbooleanJoWhether the mailbox may send.
receivebooleanJoWhether the mailbox may receive.

Përgjigja

EmriLlojiKërkohetÇfarë është kjo
idUuidPoUUIDv7 identifier — sortable by creation time (docs/02 §8).
addressstringPoThe full address.
localstringPoThe part before the `@`.
quota_mbintegerPoThis mailbox's size in MB. `0` means no cap.
used_mbintegerPoHow 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_usedintegerPoHow 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_atstringJoWhen the backend was last asked. `null` until the first sweep sees it.
send_enabledbooleanPo
receive_enabledbooleanPo
statusMailboxStatusPoOne mailbox's state.
system_managedbooleanPo**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_atstringPo

Gabimet që ky pikëndalim mund të kthejë

401 · 403 · 404 · 422 · 429 · 503