Skip to Content

Get addressbook by name.

Returns collection details and sync token for a addressbook by its URL name slug.

openemail.addressbooks.getByName(
  identityId: string,
  name: string,
  options?: CallOptions,
): ApiPromise<PimCollection>

It calls GET /identities/{identityId}/addressbooks/by-name/{name}: Get addressbook by name in the API reference.

Example

const pimCollection = await openemail.addressbooks.getByName(identityId, name)

Arguments

ArgumentTypeDescription
identityIdstringIdentity ULID identifier. The path's {identityId}.
namestringThe collection's name slug (exact match). The path's {name}.

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, PimCollection. 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
404No collection by that name, or mailbox not accessible
503temporary_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

It names these types of the API, each on a page of its own: PimCollection.