mailboxAddressLists.importEntries
Import patterns into an address list from CSV.
Adds every row of a CSV document to the list. Columns are pattern,note,expires_at, named by an optional header row or taken by position; expires_at is epoch seconds or an ISO 8601 date-time, empty for never. Lines starting with # and blank lines are ignored, so a plain one-address-per-line file imports too. Invalid rows (bad pattern, past or unparseable expiry) are skipped and reported; the whole import is refused with 409 list_full when the new rows would exceed the list's cap. Idempotent: re-importing an export writes nothing new.
openemail.mailboxAddressLists.importEntries(
mailboxId: string,
listId: string,
csv: RawBody,
options?: CallOptions,
): ApiPromise<AddressListBatchResult>It calls POST /mailboxes/{mailboxId}/lists/{listId}/entries/import: Import patterns into an address list from CSV in the API reference.
Example
const addressListBatchResult = await openemail.mailboxAddressLists.importEntries(mailboxId, listId, csv)Arguments
| Argument | Type | Description |
|---|---|---|
mailboxId | string | Mailbox ULID identifier. The path's {mailboxId}. |
listId | string | List id. The path's {listId}. |
csv | RawBody | CSV document, at most 1 MiB. The request's body, as bytes: text, a Blob, an ArrayBuffer or a Uint8Array (raw bodies). |
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, AddressListBatchResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
400 | validation_failed, or invalid_pattern |
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
403 | account_credentials_required — a mailbox credential may mutate inbound lists only; outbound lists are administrator-managed |
404 | not_found — the account, mailbox, scope or list is not accessible |
409 | list_full |
413 | payload_too_large — the document exceeds 1 MiB |
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: AddressListBatchResult.