Class InternetAddressAbstract

onChanged

encoding

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

Abstractclone

• clone(): InternetAddress

  Clones this internet address.

  Returns InternetAddress

Abstractequals

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

  Determines whether this address equals another address.

  Parameters

  • other: InternetAddress | null | undefined

  Returns boolean

Abstractencode

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

  Encodes this address.

  Parameters

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

  Returns string

AbstracttoString

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

  Serializes this address.

  Parameters

  • Optionaloptions: FormatOptions
  • Optionalencode: boolean

  Returns string

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

Staticparse

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

  Parses an internet address.

  Parameters

  • text: string | Uint8Array<ArrayBufferLike>

    The text to parse.

  • options: ParserOptions = ParserOptions.default

    The parser options.

  Returns Result<InternetAddress>

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

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.