accounts.setRetention
Set account default retention window.
Sets the account DEFAULT retention window in days — the window every mailbox the account owns enforces unless it has one of its own, EXISTING mailboxes included, pushed to each store by a background walk. The owning account key or a system key. Refused below the platform floor. Answers the same view as GET — the default now in force and one page of per-mailbox previews of it — read it. Mail expunged under the window is restorable for 14 days; to recover from a wrong window, clear or raise it FIRST, then restore.
openemail.accounts.setRetention(
accountId: string,
body: AccountsSetRetentionBody,
options?: CallOptions,
): ApiPromise<AccountRetention>It calls PUT /accounts/{accountId}/retention: Set account default retention window in the API reference.
Example
const accountRetention = await openemail.accounts.setRetention(accountId, { retentionDays: 1 })Arguments
| Argument | Type | Description |
|---|---|---|
accountId | string | Account ULID identifier. The path's {accountId}. |
body | AccountsSetRetentionBody | The request's body. |
Options
It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).
Answer
Awaited, it is the API's JSON, AccountRetention. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
400 | validation_failed, or retention_too_short (the window is below the platform floor; the body carries minDays) |
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | Account not found or not accessible to this principal |
409 | account_deleted — the account is inside its deletion window or purged; restore it first |
413 | too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing |
503 | temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |
A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.
Types
AccountsSetRetentionBody
/** The body of `accounts.setRetention`. */
type AccountsSetRetentionBody = {
/** The account DEFAULT window in days, applied to every mailbox the account owns that has no window of its own — EXISTING mailboxes included (it is read at resolution time, not copied at create), so preview it first with GET ?days=. Refused below the platform floor (400 retention_too_short). Pushed to the account's stores by a paged background walk; deliberately outside the plan system, so a plan change never touches it */
retentionDays: number
}It names these types of the API, each on a page of its own: AccountRetention.