Class DkimBodyFilter`Abstract`

A base implementation for DKIM body filters.

Hierarchy (View Summary)

MimeFilterBase
- DkimBodyFilter
  - DkimSimpleBodyFilter
  - DkimRelaxedBodyFilter

Index

Constructors

Properties

lastWasNewLine isEmptyLine emptyLines outputBuffer?

Methods

filterInternal filter flush reset saveRemainingInput ensureOutputSize

Constructors

constructor

new DkimBodyFilter(): DkimBodyFilter

Returns DkimBodyFilter

Inherited from MimeFilterBase.constructor

Properties

lastWasNewLine

lastWasNewLine: boolean = false

Whether the last filtered character was a newline.

`Protected`isEmptyLine

isEmptyLine: boolean = false

Whether the current line is empty.

`Protected`emptyLines

emptyLines: number = 0

The number of consecutive empty lines encountered.

`Protected` `Optional`outputBuffer

outputBuffer?: Uint8Array<ArrayBufferLike>

The reusable output buffer used by this filter.

Methods

`Protected` `Abstract`filterInternal

filterInternal(
    input: Uint8Array,
    startIndex: number,
    length: number,
    flush: boolean,
): MimeFilterResult
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.
Inherited from MimeFilterBase.filterInternal
- Defined in src/io/filters/mime-filter-base.ts:22

filter

filter(input: Uint8Array, startIndex: number, length: number): MimeFilterResult
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.

Throws
input is not a Uint8Array.

Throws
startIndex and length do not specify a valid range in input.
Inherited from MimeFilterBase.filter
- Defined in src/io/filters/mime-filter-base.ts:71

flush

flush(input: Uint8Array, startIndex: number, length: number): MimeFilterResult
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.

Throws
input is not a Uint8Array.

Throws
startIndex and length do not specify a valid range in input.
Inherited from MimeFilterBase.flush
- Defined in src/io/filters/mime-filter-base.ts:90

reset

reset(): void
Reset the filter.

Returns void
Inherited from MimeFilterBase.reset
- Defined in src/io/filters/mime-filter-base.ts:102

`Protected`saveRemainingInput

saveRemainingInput(input: Uint8Array, startIndex: number, length: number): void
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
Inherited from MimeFilterBase.saveRemainingInput
- Defined in src/io/filters/mime-filter-base.ts:113

`Protected`ensureOutputSize

ensureOutputSize(size: number, keep: boolean): Uint8Array
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.
Inherited from MimeFilterBase.ensureOutputSize
- Defined in src/io/filters/mime-filter-base.ts:131