Class InternetAddressList

constructor

• new InternetAddressList(
      addresses?: Iterable<InternetAddress, any, any>,
  ): InternetAddressList

  Creates a new internet address list.

  Parameters

  • Optionaladdresses: Iterable<InternetAddress, any, any>

  Returns InternetAddressList

onChanged

count

• get count(): number

  The number of addresses in the list.

  Returns number

isReadOnly

• get isReadOnly(): boolean

  Whether this list is read-only.

  Returns boolean

mailboxes

• get mailboxes(): Iterable<MailboxAddress>

  Enumerates all mailbox addresses, including members of group addresses.

  Returns Iterable<MailboxAddress>

at

• at(index: number): InternetAddress

  Gets the address at the specified index.

  Parameters

  • index: number

  Returns InternetAddress

set

• set(index: number, address: InternetAddress): void

  Sets the address at the specified index.

  Parameters

  • index: number
  • address: InternetAddress

  Returns void

indexOf

• indexOf(address: InternetAddress): number

  Gets the index of the requested address, or -1 if it is not found.

  Parameters

  • address: InternetAddress

  Returns number

insert

• insert(index: number, address: InternetAddress): void

  Inserts an address at the specified index.

  Parameters

  • index: number
  • address: InternetAddress

  Returns void

removeAt

• removeAt(index: number): void

  Removes the address at the specified index.

  Parameters

  • index: number

  Returns void

add

• add(address: InternetAddress): void

  Adds an address to the list.

  Parameters

  • address: InternetAddress

  Returns void

addRange

• addRange(addresses: Iterable<InternetAddress>): void

  Adds a sequence of addresses to the list.

  Parameters

  • addresses: Iterable<InternetAddress>

  Returns void

clear

• clear(): void

  Removes all addresses from the list.

  Returns void

contains

• contains(address: InternetAddress): boolean

  Determines whether the list contains the specified address.

  Parameters

  • address: InternetAddress

  Returns boolean

copyTo

• copyTo(array: InternetAddress[], arrayIndex: number): void

  Copies the addresses to an array.

  Parameters

  • array: InternetAddress[]
  • arrayIndex: number

  Returns void

remove

• remove(address: InternetAddress): boolean

  Removes an address from the list.

  Parameters

  • address: InternetAddress

  Returns boolean

equals

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

  Determines whether this list equals another address list.

  Parameters

  • other: InternetAddressList | null | undefined

  Returns boolean

compareTo

• compareTo(other: InternetAddressList): number

  Compares this address list with another address list.

  Parameters

  • other: InternetAddressList

  Returns number

encode

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

  Encodes the address list.

  Parameters

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

  Returns string

toString

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

  Serializes the address list.

  Parameters

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

  Returns string

[iterator]

• "[iterator]"(): Iterator<InternetAddress>

  Returns Iterator<InternetAddress>

Staticparse

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

  Parses an internet address list.

  Parameters

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

  Returns Result<InternetAddressList>

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

StaticparseInternal

• parseInternal(
      text: Uint8Array,
      cursor: { index: number },
      endIndex: number,
      options: ParserOptions,
      isGroup: boolean,
      groupDepth: number,
  ): Result<InternetAddress[]>

  Parses an address list from a byte range.

  Parameters

  • text: Uint8Array
  • cursor: { index: number }
  • endIndex: number
  • options: ParserOptions
  • isGroup: boolean
  • groupDepth: number

  Returns Result<InternetAddress[]>

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