Skip to Content

Delete addressbook.

Deletes a addressbook collection and all objects stored within it. Both move to the trash tier: GET …/addressbooks/trash lists them, POST …/trash/{id}/restore brings the collection and its members back (private, since grants and feed tokens were retired), and the purge duty removes them for good fourteen days after deletion.

openemail.addressbooks.delete(
  identityId: string,
  addressbookId: string,
  options?: CallOptions,
): ApiPromise<AddressbooksDeleteResult>

It calls DELETE /identities/{identityId}/addressbooks/{addressbookId}: Delete addressbook in the API reference.

Example

const result = await openemail.addressbooks.delete(identityId, addressbookId)

Arguments

ArgumentTypeDescription
identityIdstringMailbox identity ULID. The path's {identityId}.
addressbookIdstringCollection ULID or its name slug. The path's {addressbookId}.

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, AddressbooksDeleteResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
403default_collection — default collection cannot be deleted
404No such collection, or mailbox not accessible
503scheduling_unavailable: preparation could not complete; no deletion committed. Or 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)
507scheduling_backlog_full: pending-work or batch budget exhausted; no deletion committed

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

AddressbooksDeleteResult

/** What `addressbooks.delete` answers. */
type AddressbooksDeleteResult = {
  deleted: boolean
  objectsDestroyed: number
}