addressbooks.get
Get addressbook by ID.
Returns collection details and sync token for a addressbook by its ID.
openemail.addressbooks.get(
identityId: string,
addressbookId: string,
options?: CallOptions,
): ApiPromise<PimCollection>It calls GET /identities/{identityId}/addressbooks/{addressbookId}: Get addressbook by ID in the API reference.
Example
const pimCollection = await openemail.addressbooks.get(identityId, addressbookId)Arguments
| Argument | Type | Description |
|---|---|---|
identityId | string | Mailbox identity ULID. The path's {identityId}. |
addressbookId | string | Collection 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, PimCollection. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | No such collection, or mailbox not accessible |
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
It names these types of the API, each on a page of its own: PimCollection.