Class MimeReader

A forward-only, event-driven MIME reader.

MimeReader tokenizes MIME input and invokes protected event hooks as it reads messages, entities, headers, boundaries, and content.

Hierarchy (View Summary)

MimeReader
- MimeParser

Constructors

constructor

new MimeReader(stream: Stream, format?: MimeFormat): MimeReader
Initializes a new MIME reader.
Parameters
- stream: Stream
  The input stream.
- Optionalformat: MimeFormat
  The MIME input format.
Returns MimeReader
- Defined in src/mime-reader.ts:184
new MimeReader(
    options: ParserOptions,
    stream: Stream,
    format?: MimeFormat,
): MimeReader
Parameters
- options: ParserOptions
- stream: Stream
- Optionalformat: MimeFormat
Returns MimeReader
- Defined in src/mime-reader.ts:185

Properties

`Protected`stream

stream: Stream

`Protected`streamPosition

streamPosition: number = 0

Accessors

Options

get Options(): ParserOptions
Gets or sets parser options.

Returns ParserOptions
- Defined in src/mime-reader.ts:204
set Options(value: ParserOptions): void
Sets parser options.
Parameters
- value: ParserOptions
Returns void
- Defined in src/mime-reader.ts:208

isEndOfStream

get isEndOfStream(): boolean
Gets whether the reader has reached end-of-stream.

Returns boolean
- Defined in src/mime-reader.ts:218

Position

get Position(): number
Gets the current reader position.

Returns number
- Defined in src/mime-reader.ts:223

Methods

setStream

setStream(stream: Stream, format?: MimeFormat): void
Resets the reader to use a new input stream.
Parameters
- stream: Stream
  The input stream.
- format: MimeFormat = 'entity'
  The MIME input format.
Returns void
- Defined in src/mime-reader.ts:260

`Protected`onMboxMarkerBegin

onMboxMarkerBegin(_beginOffset: number, _lineNumber: number): void
Parameters
- _beginOffset: number
- _lineNumber: number
Returns void
- Defined in src/mime-reader.ts:266

`Protected`onMboxMarkerRead

onMboxMarkerRead(
    _buffer: Uint8Array,
    _startIndex: number,
    _count: number,
    _beginOffset: number,
    _lineNumber: number,
): void
Parameters
- _buffer: Uint8Array
- _startIndex: number
- _count: number
- _beginOffset: number
- _lineNumber: number
Returns void
- Defined in src/mime-reader.ts:267

`Protected`onMboxMarkerEnd

onMboxMarkerEnd(
    _beginOffset: number,
    _lineNumber: number,
    _endOffset: number,
): void
Parameters
- _beginOffset: number
- _lineNumber: number
- _endOffset: number
Returns void
- Defined in src/mime-reader.ts:268

`Protected`onHeadersBegin

onHeadersBegin(_beginOffset: number, _beginLineNumber: number): void
Parameters
- _beginOffset: number
- _beginLineNumber: number
Returns void
- Defined in src/mime-reader.ts:270

`Protected`onHeaderRead

onHeaderRead(_header: Header, _beginLineNumber: number): void
Parameters
- _header: Header
- _beginLineNumber: number
Returns void
- Defined in src/mime-reader.ts:271

`Protected`onHeadersEnd

onHeadersEnd(
    _beginOffset: number,
    _beginLineNumber: number,
    _endOffset: number,
    _endLineNumber: number,
): void
Parameters
- _beginOffset: number
- _beginLineNumber: number
- _endOffset: number
- _endLineNumber: number
Returns void
- Defined in src/mime-reader.ts:272

`Protected`onBodySeparator

onBodySeparator(
    _beginOffset: number,
    _lineNumber: number,
    _endOffset: number,
): void
Parameters
- _beginOffset: number
- _lineNumber: number
- _endOffset: number
Returns void
- Defined in src/mime-reader.ts:273

`Protected`onMimeMessageBegin

onMimeMessageBegin(_beginOffset: number, _beginLineNumber: number): void
Parameters
- _beginOffset: number
- _beginLineNumber: number
Returns void
- Defined in src/mime-reader.ts:275

`Protected`onMimeMessageEnd

onMimeMessageEnd(
    _beginOffset: number,
    _beginLineNumber: number,
    _headersEndOffset: number,
    _endOffset: number,
    _lines: number,
): void
Parameters
- _beginOffset: number
- _beginLineNumber: number
- _headersEndOffset: number
- _endOffset: number
- _lines: number
Returns void
- Defined in src/mime-reader.ts:276

`Protected`onMimePartBegin

onMimePartBegin(
    _contentType: ContentType,
    _beginOffset: number,
    _beginLineNumber: number,
): void
Parameters
- _contentType: ContentType
- _beginOffset: number
- _beginLineNumber: number
Returns void
- Defined in src/mime-reader.ts:278

`Protected`onMimePartContentBegin

onMimePartContentBegin(_beginOffset: number, _beginLineNumber: number): void
Parameters
- _beginOffset: number
- _beginLineNumber: number
Returns void
- Defined in src/mime-reader.ts:279

`Protected`onMimePartContentRead

onMimePartContentRead(
    _buffer: Uint8Array,
    _startIndex: number,
    _count: number,
): void
Parameters
- _buffer: Uint8Array
- _startIndex: number
- _count: number
Returns void
- Defined in src/mime-reader.ts:280

`Protected`onMimePartContentEnd

onMimePartContentEnd(
    _beginOffset: number,
    _beginLineNumber: number,
    _endOffset: number,
    _lines: number,
    _newLineFormat: ReaderNewLineFormat | null,
): void
Parameters
- _beginOffset: number
- _beginLineNumber: number
- _endOffset: number
- _lines: number
- _newLineFormat: ReaderNewLineFormat | null
Returns void
- Defined in src/mime-reader.ts:281

`Protected`onMimePartEnd

onMimePartEnd(
    _contentType: ContentType,
    _beginOffset: number,
    _beginLineNumber: number,
    _headersEndOffset: number,
    _endOffset: number,
    _lines: number,
): void
Parameters
- _contentType: ContentType
- _beginOffset: number
- _beginLineNumber: number
- _headersEndOffset: number
- _endOffset: number
- _lines: number
Returns void
- Defined in src/mime-reader.ts:282

`Protected`onMessagePartBegin

onMessagePartBegin(
    _contentType: ContentType,
    _beginOffset: number,
    _beginLineNumber: number,
): void
Parameters
- _contentType: ContentType
- _beginOffset: number
- _beginLineNumber: number
Returns void
- Defined in src/mime-reader.ts:284

`Protected`onMessagePartEnd

onMessagePartEnd(
    _contentType: ContentType,
    _beginOffset: number,
    _beginLineNumber: number,
    _headersEndOffset: number,
    _endOffset: number,
    _lines: number,
): void
Parameters
- _contentType: ContentType
- _beginOffset: number
- _beginLineNumber: number
- _headersEndOffset: number
- _endOffset: number
- _lines: number
Returns void
- Defined in src/mime-reader.ts:285

`Protected`onMultipartBegin

onMultipartBegin(
    _contentType: ContentType,
    _beginOffset: number,
    _beginLineNumber: number,
): void
Parameters
- _contentType: ContentType
- _beginOffset: number
- _beginLineNumber: number
Returns void
- Defined in src/mime-reader.ts:287

`Protected`onMultipartBoundaryBegin

onMultipartBoundaryBegin(_beginOffset: number, _lineNumber: number): void
Parameters
- _beginOffset: number
- _lineNumber: number
Returns void
- Defined in src/mime-reader.ts:288

`Protected`onMultipartBoundaryRead

onMultipartBoundaryRead(
    _buffer: Uint8Array,
    _startIndex: number,
    _count: number,
    _beginOffset: number,
    _lineNumber: number,
): void
Parameters
- _buffer: Uint8Array
- _startIndex: number
- _count: number
- _beginOffset: number
- _lineNumber: number
Returns void
- Defined in src/mime-reader.ts:289

`Protected`onMultipartBoundaryEnd

onMultipartBoundaryEnd(
    _beginOffset: number,
    _lineNumber: number,
    _endOffset: number,
): void
Parameters
- _beginOffset: number
- _lineNumber: number
- _endOffset: number
Returns void
- Defined in src/mime-reader.ts:290

`Protected`onMultipartEndBoundaryBegin

onMultipartEndBoundaryBegin(_beginOffset: number, _lineNumber: number): void
Parameters
- _beginOffset: number
- _lineNumber: number
Returns void
- Defined in src/mime-reader.ts:291

`Protected`onMultipartEndBoundaryRead

onMultipartEndBoundaryRead(
    _buffer: Uint8Array,
    _startIndex: number,
    _count: number,
    _beginOffset: number,
    _lineNumber: number,
): void
Parameters
- _buffer: Uint8Array
- _startIndex: number
- _count: number
- _beginOffset: number
- _lineNumber: number
Returns void
- Defined in src/mime-reader.ts:292

`Protected`onMultipartEndBoundaryEnd

onMultipartEndBoundaryEnd(
    _beginOffset: number,
    _lineNumber: number,
    _endOffset: number,
): void
Parameters
- _beginOffset: number
- _lineNumber: number
- _endOffset: number
Returns void
- Defined in src/mime-reader.ts:293

`Protected`onMultipartPreambleBegin

onMultipartPreambleBegin(_beginOffset: number, _beginLineNumber: number): void
Parameters
- _beginOffset: number
- _beginLineNumber: number
Returns void
- Defined in src/mime-reader.ts:294

`Protected`onMultipartPreambleRead

onMultipartPreambleRead(
    _buffer: Uint8Array,
    _startIndex: number,
    _count: number,
): void
Parameters
- _buffer: Uint8Array
- _startIndex: number
- _count: number
Returns void
- Defined in src/mime-reader.ts:295

`Protected`onMultipartPreambleEnd

onMultipartPreambleEnd(
    _beginOffset: number,
    _beginLineNumber: number,
    _endOffset: number,
    _lines: number,
): void
Parameters
- _beginOffset: number
- _beginLineNumber: number
- _endOffset: number
- _lines: number
Returns void
- Defined in src/mime-reader.ts:296

`Protected`onMultipartEpilogueBegin

onMultipartEpilogueBegin(_beginOffset: number, _beginLineNumber: number): void
Parameters
- _beginOffset: number
- _beginLineNumber: number
Returns void
- Defined in src/mime-reader.ts:297

`Protected`onMultipartEpilogueRead

onMultipartEpilogueRead(
    _buffer: Uint8Array,
    _startIndex: number,
    _count: number,
): void
Parameters
- _buffer: Uint8Array
- _startIndex: number
- _count: number
Returns void
- Defined in src/mime-reader.ts:298

`Protected`onMultipartEpilogueEnd

onMultipartEpilogueEnd(
    _beginOffset: number,
    _beginLineNumber: number,
    _endOffset: number,
    _lines: number,
): void
Parameters
- _beginOffset: number
- _beginLineNumber: number
- _endOffset: number
- _lines: number
Returns void
- Defined in src/mime-reader.ts:299

`Protected`onMultipartEnd

onMultipartEnd(
    _contentType: ContentType,
    _beginOffset: number,
    _beginLineNumber: number,
    _headersEndOffset: number,
    _endOffset: number,
    _lines: number,
): void
Parameters
- _contentType: ContentType
- _beginOffset: number
- _beginLineNumber: number
- _headersEndOffset: number
- _endOffset: number
- _lines: number
Returns void
- Defined in src/mime-reader.ts:300

readHeaders

readHeaders(): void
Reads a header block and emits header events.

Returns void

Throws
The input cannot be parsed as headers.
- Defined in src/mime-reader.ts:1480

readEntity

readEntity(): void
Reads a MIME entity and emits entity events.

Returns void

Throws
The input cannot be parsed as an entity.
- Defined in src/mime-reader.ts:1494

readMessage

readMessage(): void
Reads a MIME message and emits message and entity events.

Returns void

Throws
The input cannot be parsed as a message.
- Defined in src/mime-reader.ts:1551

Class MimeReader

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MimeReader

Parameters

Returns MimeReader

Properties

Protectedstream

ProtectedstreamPosition

Accessors

Options

Returns ParserOptions

Parameters

Returns void

isEndOfStream

Returns boolean

Position

Returns number

Methods

setStream

Parameters

Returns void

ProtectedonMboxMarkerBegin

Parameters

Returns void

ProtectedonMboxMarkerRead

Parameters

Returns void

ProtectedonMboxMarkerEnd

Parameters

Returns void

ProtectedonHeadersBegin

Parameters

Returns void

ProtectedonHeaderRead

Parameters

Returns void

ProtectedonHeadersEnd

Parameters

Returns void

ProtectedonBodySeparator

Parameters

Returns void

ProtectedonMimeMessageBegin

Parameters

Returns void

ProtectedonMimeMessageEnd

Parameters

Returns void

ProtectedonMimePartBegin

Parameters

Returns void

ProtectedonMimePartContentBegin

Parameters

Returns void

ProtectedonMimePartContentRead

Parameters

Returns void

ProtectedonMimePartContentEnd

Parameters

Returns void

ProtectedonMimePartEnd

Parameters

Returns void

ProtectedonMessagePartBegin

Parameters

Returns void

ProtectedonMessagePartEnd

Parameters

Returns void

ProtectedonMultipartBegin

Parameters

Returns void

`Protected`stream

`Protected`streamPosition

`Protected`onMboxMarkerBegin

`Protected`onMboxMarkerRead

`Protected`onMboxMarkerEnd

`Protected`onHeadersBegin

`Protected`onHeaderRead

`Protected`onHeadersEnd

`Protected`onBodySeparator

`Protected`onMimeMessageBegin

`Protected`onMimeMessageEnd

`Protected`onMimePartBegin

`Protected`onMimePartContentBegin

`Protected`onMimePartContentRead

`Protected`onMimePartContentEnd

`Protected`onMimePartEnd

`Protected`onMessagePartBegin

`Protected`onMessagePartEnd

`Protected`onMultipartBegin

`Protected`onMultipartBoundaryBegin

`Protected`onMultipartBoundaryRead

`Protected`onMultipartBoundaryEnd

`Protected`onMultipartEndBoundaryBegin

`Protected`onMultipartEndBoundaryRead

`Protected`onMultipartEndBoundaryEnd

`Protected`onMultipartPreambleBegin

`Protected`onMultipartPreambleRead

`Protected`onMultipartPreambleEnd

`Protected`onMultipartEpilogueBegin

`Protected`onMultipartEpilogueRead

`Protected`onMultipartEpilogueEnd

`Protected`onMultipartEnd