Class TnefReader

constructor

• new TnefReader(
      inputStream: Uint8Array<ArrayBufferLike> | Stream,
      defaultMessageCodepage?: number,
      complianceMode?: TnefComplianceMode,
  ): TnefReader

  Creates a new TNEF reader.

  When reading with strict compliance, a TnefError is thrown immediately at the first sign of invalid or corrupted data. When reading with loose compliance, issues are accumulated in complianceStatus unless the stream is too corrupted to continue.

  Parameters

  • inputStream: Uint8Array<ArrayBufferLike> | Stream

    the input stream or bytes.

  • defaultMessageCodepage: number = 0

    the default message codepage.

  • complianceMode: TnefComplianceMode = 'loose'

    the compliance mode.

  Returns TnefReader

  Throws

  defaultMessageCodepage is negative.

  Throws

  the TNEF stream is corrupted or invalid in strict mode.

Static ReadonlytnefSignature

ReadonlytnefPropertyReader

ReadonlycomplianceMode

complianceStatus

attachmentKey

attributeLevel

attributeTag

attributeRawValueLength

attributeRawValueStreamOffset

tnefVersion

messageCodepage

streamOffset

• get streamOffset(): number

  Gets the current stream offset.

  Returns number

attributeType

• get attributeType(): number

  Gets the current attribute's type.

  Returns number

setMessageCodepage

• setMessageCodepage(value: number): void

  Set the message codepage.

  Invalid codepages are recorded as compliance issues and fall back to Windows-1252 unless strict mode raises a TnefError.

  Parameters

  • value: number

    the message codepage.

  Returns void

  Throws

  value is invalid in strict mode.

resetComplianceStatus

• resetComplianceStatus(): void

  Reset the compliance status to TnefComplianceStatus.Compliant.

  Returns void

close

• close(): void

  Close the reader.

  Returns void

dispose

• dispose(): void

  Dispose the reader.

  Returns void

setComplianceError

• setComplianceError(error: TnefComplianceStatus, cause?: unknown): void

  Set a TNEF compliance error.

  In strict mode this raises a TnefError; otherwise it records the error in complianceStatus.

  Parameters

  • error: TnefComplianceStatus

    the compliance error.

  • Optionalcause: unknown

    the underlying cause.

  Returns void

  Throws

  strict mode is enabled and error is not compliant.

readNextAttribute

• readNextAttribute(): boolean

  Read the next TNEF attribute.

  Returns boolean

  true if another attribute is available; otherwise, false.

  Throws

  the TNEF stream is corrupted or invalid in strict mode.

readAttributeRawValue

• readAttributeRawValue(buffer: Uint8Array, offset: number, count: number): number

  Read bytes from the current attribute's raw value.

  Parameters

  • buffer: Uint8Array

    the buffer to read data into.

  • offset: number

    the offset into the buffer to start reading data.

  • count: number

    the number of bytes to read.

  Returns number

  the number of bytes read into the buffer.

  Throws

  offset or count is out of range.

readByte

• readByte(): number

  Read a single byte.

  Returns number

  the byte value.

readInt16

• readInt16(): number

  Read a signed 16-bit integer.

  Returns number

  the integer value.

readInt32

• readInt32(): number

  Read a signed 32-bit integer.

  Returns number

  the integer value.

peekInt32

• peekInt32(): number

  Peek at the next signed 32-bit integer without advancing the stream.

  Returns number

  the integer value.

readInt64

• readInt64(): number

  Read a signed 64-bit integer.

  Returns number

  the integer value.

readSingle

• readSingle(): number

  Read a 32-bit floating point value.

  Returns number

  the floating point value.

readDouble

• readDouble(): number

  Read a 64-bit floating point value.

  Returns number

  the floating point value.

skip

• skip(count: number): boolean

  Skip bytes in the TNEF stream.

  Parameters

  • count: number

    the number of bytes to skip.

  Returns boolean

  true if all bytes were skipped; otherwise, false.