accounts.setRecoveryPolicy
Set the account's mailbox recovery policy.
Chooses whether mailbox users in this account may recover their own password (recovery codes, and the recovery address once it ships), or whether resets come from an admin only. admin_only keeps any existing recovery codes and addresses and refuses their use.
openemail.accounts.setRecoveryPolicy(
accountId: string,
body: AccountsSetRecoveryPolicyBody,
options?: CallOptions,
): ApiPromise<RecoveryPolicy>It calls PUT /accounts/{accountId}/recovery-policy: Set the account's mailbox recovery policy in the API reference.
Example
const recoveryPolicy = await openemail.accounts.setRecoveryPolicy(accountId, { policy: 'self_service' })Arguments
| Argument | Type | Description |
|---|---|---|
accountId | string | Account ULID identifier. The path's {accountId}. |
body | AccountsSetRecoveryPolicyBody | 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, RecoveryPolicy. 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 |
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
AccountsSetRecoveryPolicyBody
/** The body of `accounts.setRecoveryPolicy`. */
type AccountsSetRecoveryPolicyBody = {
/** self_service: users may recover their own mailbox. admin_only: recovery rows are kept and refused */
policy: ('self_service' | 'admin_only')
}It names these types of the API, each on a page of its own: RecoveryPolicy.