mail

PUT /v1/mail/mailboxes/{mailboxId}

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

Svi mail krajnji točke

Sva developerska dokumentacija

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu mail.manage; ključ bez nje se odbija s kodom 403, a ne 404.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Parametri

NazivVrstaObaveznoŠto je to
mailboxId (path)UuidDaMailbox ID (UUIDv7).

Tijelo zahtjeva

NazivVrstaObaveznoŠto je to
quota_mbintegerNeNew mailbox size in MB. Capped by the plan allowance captured on the service, and above that by the backend package ceiling.
sendbooleanNeWhether the mailbox may send.
receivebooleanNeWhether the mailbox may receive.

Odgovor

NazivVrstaObaveznoŠto je to
idUuidDaUUIDv7 identifier — sortable by creation time (docs/02 §8).
addressstringDaThe full address.
localstringDaThe part before the @.
quota_mbintegerDaThis mailbox's size in MB. 0 means no cap.
used_mbintegerDaHow 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_usedintegerDaHow 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_atstringNeWhen the backend was last asked. null until the first sweep sees it.
send_enabledbooleanDa
receive_enabledbooleanDa
statusMailboxStatusDaOne mailbox's state.
system_managedbooleanDaWe 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_atstringDa

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422 · 429 · 503