Class MimeIterator

constructor

• new MimeIterator(message: MimeMessage): MimeIterator

  Creates a new MIME iterator.

  Parameters

  • message: MimeMessage

    The message to iterate.

  Returns MimeIterator

  Throws

  message is null or undefined.

Readonlymessage

Message

• get Message(): MimeMessage

  The message being iterated.

  Returns MimeMessage

current

• get current(): MimeEntity

  The current MIME entity.

  Returns MimeEntity

Current

• get Current(): MimeEntity

  The current MIME entity.

  Returns MimeEntity

parent

• get parent(): MimeEntity | null

  The parent entity of the current entity, if available.

  Returns MimeEntity | null

Parent

• get Parent(): MimeEntity | null

  The parent entity of the current entity, if available.

  Returns MimeEntity | null

depth

• get depth(): number

  The depth of the current entity in the MIME tree.

  Returns number

Depth

• get Depth(): number

  The depth of the current entity in the MIME tree.

  Returns number

pathSpecifier

• get pathSpecifier(): string

  The path specifier for the current entity.

  Returns string

PathSpecifier

• get PathSpecifier(): string

  The path specifier for the current entity.

  Returns string

moveNext

• moveNext(): boolean

  Advances the iterator to the next entity.

  Returns boolean

  true if the iterator advanced; otherwise, false.

MoveNext

• MoveNext(): boolean

  Advances the iterator to the next entity.

  Returns boolean

moveTo

• moveTo(pathSpecifier: string): boolean

  Advances the iterator to the specified path.

  Parameters

  • pathSpecifier: string

    The path specifier.

  Returns boolean

  true if the iterator moved to the requested entity; otherwise, false.

  Throws

  pathSpecifier is null, undefined, or empty.

MoveTo

• MoveTo(pathSpecifier: string): boolean

  Advances the iterator to the specified path.

  Parameters

  • pathSpecifier: string

  Returns boolean

reset

• reset(): void

  Resets the iterator to its initial position.

  Returns void

Reset

• Reset(): void

  Resets the iterator to its initial position.

  Returns void

[iterator]

• "[iterator]"(): IterableIterator<MimeEntity>

  Returns IterableIterator<MimeEntity>