mimekit-ts - v1.0.0
    Preparing search index...

    Class MimeParser

    Parses MIME streams into messages, entities, or headers.

    Parser data errors are returned as Result values. Programmer errors, such as invalid constructor arguments, still throw.

    Hierarchy (View Summary)

    Index
    stream: Stream
    streamPosition: number = 0
    • get mboxMarkerOffset(): number

      Gets the offset of the current mbox marker, or -1 if none was read.

      Returns number

    • get mboxMarker(): string | null

      Gets the current mbox marker line, if one was read.

      Returns string | null

    • get isEndOfStream(): boolean

      Gets whether the reader has reached end-of-stream.

      Returns boolean

    • get Position(): number

      Gets the current reader position.

      Returns number

    • Resets the parser to use a new input stream.

      Parameters

      • stream: Stream

        The input stream.

      • format: MimeFormat = 'entity'

        The MIME input format.

      • persistent: boolean = false

        Whether parsed content should reference the source stream.

      Returns void

    • Parameters

      • beginOffset: number
      • _beginLineNumber: number
      • endOffset: number

      Returns void

    • Parameters

      • beginOffset: number
      • _beginLineNumber: number
      • endOffset: number

      Returns void

    • Parameters

      • _beginOffset: number
      • _lineNumber: number
      • _endOffset: number

      Returns void

    • Parameters

      • _beginOffset: number
      • _lineNumber: number
      • _endOffset: number

      Returns void

    • Parameters

      • _beginOffset: number
      • _lineNumber: number
      • _endOffset: number

      Returns void