Class SecureMailboxAddress

onChanged

encoding

Readonlyroute

name

• get name(): string | null

  The display name for the address, if available.

  Returns string | null

• set name(value: string | null): void

  Parameters

  • value: string | null

  Returns void

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

compareTo

• compareTo(other: InternetAddress): number

  Compares this address with another address.

  Parameters

  • other: InternetAddress

  Returns number

StaticencodeInternationalizedPhrase

• encodeInternationalizedPhrase(phrase: string): string

  Encodes an internationalized display-name phrase when quoting is required.

  Parameters

  • phrase: string

  Returns string

StatictryParseInternal

• tryParseInternal(
      flags: AddressParserFlags,
      options: ParserOptions,
      text: Uint8Array,
      cursor: ParseCursor,
      endIndex: number,
      groupDepth: number,
  ): Result<InternetAddress>

  Attempts to parse an internet address from a byte range.

  Parameters

  • flags: AddressParserFlags
  • options: ParserOptions
  • text: Uint8Array
  • cursor: ParseCursor
  • endIndex: number
  • groupDepth: number

  Returns Result<InternetAddress>

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

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.