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

    Class DkimSignatureStream

    A DKIM signature stream.

    Feeds header bytes into a DigestSigner; generateSignature and verifySignature perform the (asynchronous) signature operation.

    Hierarchy (View Summary)

    Index
    constructor
    signer
    canRead canWrite canSeek canTimeout length position
    generateSignature verifySignature read write seek flush setLength dispose copyTo validateBufferArguments throwNotSupported
    signer: DigestSigner

    The digest signer.

    • Generate the signature.

      Returns Promise<Uint8Array<ArrayBufferLike>>

      The signature.

    • Verify the DKIM signature.

      Parameters

      • signature: string

        The base64-encoded DKIM signature from the b= parameter.

      Returns Promise<boolean>

      true if the signature is valid; otherwise, false.

      signature is null or undefined.

    • Reading from a signature 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, feeding the digest signer.

      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.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods