Skip to Content

Export an address list as CSV.

Returns every live pattern of the list as CSV with the columns pattern,note,expires_at (expires_at in epoch seconds, empty for never). The file round-trips through the import endpoint unchanged.

openemail.mailboxAddressLists.exportEntries(
  mailboxId: string,
  listId: string,
  options?: CallOptions,
): ApiPromise<string>

It calls GET /mailboxes/{mailboxId}/lists/{listId}/entries/export: Export an address list as CSV in the API reference.

Example

const text = await openemail.mailboxAddressLists.exportEntries(mailboxId, listId)

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.
listIdstringList id. The path's {listId}.

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

Errors

StatusWhat it means
400validation_failed, or invalid_pattern
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404not_found — the account, mailbox, scope or list is 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.