Skip to Content

Create pattern route.

Creates a wildcard email pattern route (e.g. 'support-' or '') directed to a mailbox, webhook, remote forward, or alias.

openemail.patterns.create(
  body: PatternsCreateBody,
  options?: CallOptions,
): ApiPromise<Pattern>

It calls POST /patterns: Create pattern route in the API reference.

Example

const pattern = await openemail.patterns.create({
  destinationType: 'mailbox',
  domain: 'example.com',
  pattern: '*@example.com',
})

Arguments

ArgumentTypeDescription
bodyPatternsCreateBodyThe 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, Pattern. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_failed, invalid_address (malformed remoteAddress), unknown_domain, domain_is_alias, invalid_pattern, pattern_limit, unknown_mailbox (missing, inaccessible, or outside the pattern domain's account, including platform domains), webhook_format_unavailable (reference format asked for on a deployment that mints no capability URLs), invalid_alias_address, alias_target_unresolvable, destination_is_self, destination_loops, or destination_chain_too_long
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
409pattern_exists
413too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing
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.

Types

PatternsCreateBody

/** The body of `patterns.create`. */
type PatternsCreateBody = {
  aliasAddress?: string
  destinationType: ('mailbox' | 'webhook' | 'remote' | 'alias')
  domain: string
  mailboxId?: string
  /**
   * Pace inbound deliveries to this pattern's mailbox through the paced queue (funnel protection). Mailbox patterns only; ignored at delivery time for other destination types.
   * @default false
   */
  paced?: boolean
  pattern: string
  priority?: number
  remoteAddress?: string
  webhookFormat?: ('parsed' | 'reference')
  webhookSecret?: string | null
  webhookUrl?: string
}

It names these types of the API, each on a page of its own: Pattern.