mailboxAddressLists.addEntry
Add a pattern to an address list.
Adds an email address, domain, or wildcard pattern to an address list. Idempotent.
openemail.mailboxAddressLists.addEntry(
mailboxId: string,
listId: string,
body: MailboxAddressListsAddEntryBody,
options?: CallOptions,
): ApiPromise<AddressListEntry>It calls POST /mailboxes/{mailboxId}/lists/{listId}/entries: Add a pattern to an address list in the API reference.
Example
const addressListEntry = await openemail.mailboxAddressLists.addEntry(mailboxId, listId, { pattern: '*@example.com' })Arguments
| Argument | Type | Description |
|---|---|---|
mailboxId | string | Mailbox ULID identifier. The path's {mailboxId}. |
listId | string | List id. The path's {listId}. |
body | MailboxAddressListsAddEntryBody | The request's body. |
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, AddressListEntry. 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 — maximum allowed pattern entries reached |
413 | too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing |
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
MailboxAddressListsAddEntryBody
/** The body of `mailboxAddressLists.addEntry`. */
type MailboxAddressListsAddEntryBody = {
/** Epoch seconds after which the entry stops applying (must be in the future); omit or null for never. A repeat add replaces the previous expiry. */
expiresAt?: number | null
/** Optional descriptive note for this pattern entry */
note?: string
/** Email address or domain pattern to match (e.g. user@example.com or @domain.com) */
pattern: string
}It names these types of the API, each on a page of its own: AddressListEntry.