Class MessageIdList

constructor

• new MessageIdList(): MessageIdList

  Returns MessageIdList

onChanged

count

• get count(): number

  The number of message ids.

  Returns number

isReadOnly

• get isReadOnly(): boolean

  Whether this list is read-only.

  Returns boolean

clone

• clone(): MessageIdList

  Clones this message-id list.

  Returns MessageIdList

  An exact copy of the message-id list.

at

• at(index: number): string

  Gets the message id at the specified index.

  Parameters

  • index: number

    The index.

  Returns string

  The message id.

  Throws

  index is out of range.

set

• set(index: number, value: string): void

  Sets the message id at the specified index.

  Parameters

  • index: number

    The index.

  • value: string

    The message id.

  Returns void

  Throws

  value is null or undefined.

  Throws

  index is out of range.

indexOf

• indexOf(messageId: string): number

  Gets the index of the requested message id.

  Parameters

  • messageId: string

    The message id.

  Returns number

  The index of the message id, or -1 if it is not found.

  Throws

  messageId is null or undefined.

insert

• insert(index: number, messageId: string): void

  Inserts a message id at the specified index.

  Parameters

  • index: number

    The insertion index.

  • messageId: string

    The message id to insert.

  Returns void

  Throws

  messageId is null or undefined.

  Throws

  index is out of range.

removeAt

• removeAt(index: number): void

  Removes the message id at the specified index.

  Parameters

  • index: number

    The index.

  Returns void

  Throws

  index is out of range.

add

• add(messageId: string): void

  Adds a message id.

  Parameters

  • messageId: string

    The message id.

  Returns void

  Throws

  messageId is null or undefined.

addRange

• addRange(items: Iterable<string>): void

  Adds a sequence of message ids.

  Parameters

  • items: Iterable<string>

    The message ids to add.

  Returns void

  Throws

  items is null or undefined.

clear

• clear(): void

  Removes all message ids.

  Returns void

contains

• contains(messageId: string): boolean

  Determines whether the list contains the specified message id.

  Parameters

  • messageId: string

    The message id.

  Returns boolean

  true if the message id is contained; otherwise, false.

  Throws

  messageId is null or undefined.

copyTo

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

  Copies the message ids to an array.

  Parameters

  • array: string[]

    The destination array.

  • arrayIndex: number

    The index into the array.

  Returns void

  Throws

  array is null or undefined.

  Throws

  arrayIndex is out of range.

remove

• remove(messageId: string): boolean

  Removes a message id.

  Parameters

  • messageId: string

    The message id.

  Returns boolean

  true if the message id was removed; otherwise, false.

  Throws

  messageId is null or undefined.

toString

• toString(): string

  Serializes this list as a space-separated References header value.

  Returns string

  A string representing this message-id list.

[iterator]

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

  Returns Iterator<string>