Class MailboxAddress

constructor

• new MailboxAddress(
      name: string | null | undefined,
      address: string,
      route?: Iterable<string, any, any>,
      at?: number,
  ): MailboxAddress

  Creates a new mailbox address.

  Parameters

  • name: string | null | undefined

    The display name.

  • address: string

    The mailbox address.

  • Optionalroute: Iterable<string, any, any>

    The optional route domains.

  • Optionalat: number

    The index of the @ separator in a pre-parsed address.

  Returns MailboxAddress

  Throws

  address is null or invalid.

Readonlyroute

address

• get address(): string

  The address-spec portion of the mailbox address.

  Returns string

• set address(value: string): void

  Parameters

  • value: string

  Returns void

localPart

• get localPart(): string

  The local-part of the mailbox address.

  Returns string

domain

• get domain(): string

  The domain of the mailbox address.

  Returns string

isInternational

• get isInternational(): boolean

  Whether the mailbox address contains internationalized text.

  Returns boolean

clone

• clone(): MailboxAddress

  Clones this mailbox address.

  Returns MailboxAddress

getAddress

• getAddress(idnEncode: boolean): string

  Gets the address-spec, optionally IDN-encoding the domain.

  Parameters

  • idnEncode: boolean

  Returns string

StaticencodeAddrspec

• encodeAddrspec(addrspec: string): string

  Encodes the domain portion of an address-spec using IDN when needed.

  Parameters

  • addrspec: string

  Returns string

StaticdecodeAddrspec

• decodeAddrspec(addrspec: string): string

  Decodes the domain portion of an address-spec using IDN when needed.

  Parameters

  • addrspec: string

  Returns string

encode

• encode(options: FormatOptions, firstToken: boolean, state: LineState): string

  Encodes this mailbox address.

  Parameters

  • options: FormatOptions
  • firstToken: boolean
  • state: LineState

  Returns string

toString

• toString(options?: FormatOptions, encode?: boolean): string

  Serializes this mailbox address.

  Parameters

  • options: FormatOptions = FormatOptions.default
  • encode: boolean = false

  Returns string

equals

• equals(other: InternetAddress | null | undefined): boolean

  Determines whether this mailbox address equals another address.

  Parameters

  • other: InternetAddress | null | undefined

  Returns boolean

Staticparse

• parse(
      text: string | Uint8Array<ArrayBufferLike>,
      options?: ParserOptions,
  ): Result<MailboxAddress>

  Parses a mailbox address.

  Parameters

  • text: string | Uint8Array<ArrayBufferLike>
  • options: ParserOptions = ParserOptions.default

  Returns Result<MailboxAddress>

  A Result; { ok: false } with a MimeError on malformed input.