addressbookObjects.list
List addressbook objects.
Returns a paginated list of contacts in an addressbook collection.
openemail.addressbookObjects.list(
identityId: string,
addressbookId: string,
options?: AddressbookObjectsListOptions,
): PagePromise<PimObjectPage, PimObjectPageObjectsItem>It calls GET /identities/{identityId}/addressbooks/{addressbookId}/objects: List addressbook objects in the API reference.
Example
for await (const pimObjectPageObjectsItem of openemail.addressbookObjects.list(identityId, addressbookId)) {
// every item of every page (await the call instead for one page)
}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
The last argument, options, a AddressbookObjectsListOptions, takes:
| Option | Type | Sent as | Description |
|---|---|---|---|
limit | number | query limit | Page size (default 500) |
cursor | string | query cursor | Pagination cursor from previous page |
order | ('asc' | 'desc') | query order | Sort order by creation time ('asc' or 'desc') |
fields | ('meta' | 'full' | 'json') | query fields | Fields to include: 'meta' (headers/timestamps only), 'full' (raw text body), 'json' (parsed JSCalendar/JSContact JSON) |
uid | string | query uid | Filter by exact UID |
q | string | query q | Case-insensitive substring over name, email and structured name |
name | string | query name | Case-insensitive substring over formatted name |
email | string | query email | Case-insensitive substring over email addresses |
Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).
Answer
It is a listing, a PagePromise. Awaited, it is one page as the API answers it, PimObjectPage. Iterated with for await, it is every PimObjectPageObjectsItem of every page, each page fetched as the loop reaches it.
Errors
| Status | What it means |
|---|---|
400 | expand_requires_range, search_term_too_long, or progress_requires_vtodo (progress is a task filter and cannot be combined with a non-VTODO component) |
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: PimObjectPage, PimObjectPageObjectsItem.