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

    Class DkimHashStream

    A DKIM hash stream.

    Feeds body/header bytes incrementally into a synchronous digest (see IncrementalHash); generateHash produces the final hash.

    Hierarchy (View Summary)

    Index
    • get canWrite(): boolean

      Whether the stream supports writing (always).

      Returns boolean

    • get position(): number

      The current position within the stream.

      Returns number

    • set position(_value: number): void

      Setting the position is not supported.

      Parameters

      • _value: number

      Returns void

    • Reading from a hash stream is not supported.

      Parameters

      • _buffer: Uint8Array

        The buffer to read data into.

      • _offset: number

        The offset into the buffer.

      • _count: number

        The number of bytes to read.

      Returns number

      Always thrown.

    • Write a sequence of bytes to the stream, updating the running digest.

      Parameters

      • buffer: Uint8Array

        The buffer to write.

      • offset: number

        The offset of the first byte to write.

      • count: number

        The number of bytes to write.

      Returns void

    • Copy data from this stream to another stream.

      Parameters

      • destination: Stream

        The stream that will receive the copied data.

      • bufferSize: number = 4096

        The temporary buffer size to use while copying.

      Returns void

    • Validate buffer, offset, and count arguments for stream read/write operations.

      Parameters

      • buffer: Uint8Array

        The buffer supplied by the caller.

      • offset: number

        The starting offset in the buffer.

      • count: number

        The number of bytes to read or write.

      Returns void

      offset or count does not specify a valid range in buffer.

    • Throw for an unsupported stream operation.

      Parameters

      • operation: string

        The unsupported operation name.

      Returns never

      Always thrown because the operation is unsupported.