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

    Class MboxFromFilter

    A filter that munges lines beginning with "From " by stuffing a > into the beginning of the line.

    Munging mbox-style "From " lines prevents mbox parsers from misinterpreting message content as an mbox marker delineating messages. This munging is not reversible, but is necessary when formatting a message for saving to an mbox file.

    Hierarchy (View Summary)

    Index
    constructor
    outputBuffer?
    filterInternal reset filter flush saveRemainingInput ensureOutputSize
    outputBuffer?: Uint8Array<ArrayBufferLike>

    The reusable output buffer used by this filter.

    • Filter the specified input buffer.

      Parameters

      • input: Uint8Array

        The input buffer.

      • startIndex: number

        The starting index of the input buffer.

      • length: number

        The length of the input buffer, starting at startIndex.

      • flush: boolean

        Whether all internally buffered data should be flushed to the output buffer.

      Returns MimeFilterResult

      The filtered output range.

    • Filter the specified input buffer.

      Parameters

      • input: Uint8Array

        The input buffer.

      • startIndex: number

        The starting index of the input buffer.

      • length: number

        The number of bytes of input to filter.

      Returns MimeFilterResult

      The filtered output range.

      input is not a Uint8Array.

      startIndex and length do not specify a valid range in input.

    • Filter the specified input buffer, flushing all internally buffered data to the output.

      Parameters

      • input: Uint8Array

        The input buffer.

      • startIndex: number

        The starting index of the input buffer.

      • length: number

        The number of bytes of input to filter.

      Returns MimeFilterResult

      The filtered output range.

      input is not a Uint8Array.

      startIndex and length do not specify a valid range in input.

    • Save the remaining input for the next round of processing.

      Parameters

      • input: Uint8Array

        The input buffer.

      • startIndex: number

        The starting index of the buffer to save.

      • length: number

        The length of the buffer to save, starting at startIndex.

      Returns void

    • Ensure that the output buffer is at least the specified size.

      Parameters

      • size: number

        The minimum size needed.

      • keep: boolean

        Whether the current output should be preserved.

      Returns Uint8Array

      The output buffer.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods