mail

PUT /v1/mail/mailboxes/{mailboxId}

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

すべての mail エンドポイント

すべての開発者向けドキュメント

認証

ベアラー トークンとして API キーを送信します。キーには mail.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

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

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 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_mbintegerいいえNew mailbox size in MB. Capped by the plan allowance captured on the service, and above that by the backend package ceiling.
sendbooleanいいえWhether the mailbox may send.
receivebooleanいいえWhether the mailbox may receive.

返信

名前タイプ必須これがその内容です
idUuidはいUUIDv7 identifier — sortable by creation time (docs/02 §8).
addressstringはいThe full address.
localstringはいThe part before the @.
quota_mbintegerはいThis mailbox's size in MB. 0 means no cap.
used_mbintegerはい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_usedintegerはい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_atstringいいえWhen the backend was last asked. null until the first sweep sees it.
send_enabledbooleanはい
send_suspended_atstringいいえWhen we paused this mailbox's sending because most of its recent mail was permanently refused (W43-72). null = not paused.
send_suspended_reasonstringいいえThe counts that decided the pause, in plain words. Empty when not paused.
receive_enabledbooleanはい
statusMailboxStatusはいOne mailbox's state.
system_managedbooleanはい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_atstringはい

このエンドポイントが返すエラー

401 · 403 · 404 · 422 · 429 · 503