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

    Class MessageFeedbackReport

    A message/feedback-report MIME part.

    Feedback reports are machine-readable reports describing message feedback such as abuse reports.

    Hierarchy (View Summary)

    Index
    headers: HeaderList

    The headers belonging to this MIME entity.

    contentType: ContentType

    The entity's Content-Type value.

    ensureNewLine: boolean = false
    lazyLoaded: Set<LazyField> = ...
    content: MimeContent | null = null

    The MIME content for this part.

    • get isDisposed(): boolean

      C#: internal IsDisposed (exposed publicly; upstream tests read it via InternalsVisibleTo).

      Returns boolean

    • get isAttachment(): boolean

      Gets or sets whether this entity is marked as an attachment.

      Setting this updates the Content-Disposition disposition between attachment and inline.

      Returns boolean

    • set isAttachment(value: boolean): void

      Sets whether this entity is marked as an attachment.

      Parameters

      • value: boolean

      Returns void

    • get contentDescription(): string | null

      Gets or sets the Content-Description header value.

      Returns string | null

      The part has been disposed.

    • set contentDescription(value: string | null): void

      Sets the Content-Description header value.

      Parameters

      • value: string | null

      Returns void

    • get contentDuration(): number | null

      Gets or sets the Content-Duration value in seconds.

      Returns number | null

      value is not a non-negative integer.

      The part has been disposed.

    • set contentDuration(value: number | null): void

      Sets the Content-Duration value in seconds.

      Parameters

      • value: number | null

      Returns void

    • get contentMd5(): string | null

      Gets or sets the Content-MD5 checksum value.

      Returns string | null

      The part has been disposed.

    • set contentMd5(value: string | null): void

      Sets the Content-MD5 checksum value.

      Parameters

      • value: string | null

      Returns void

    • get contentTransferEncoding(): ContentEncoding

      Gets or sets the Content-Transfer-Encoding value.

      Returns ContentEncoding

      value is not a valid content encoding or the part has been disposed.

    • set contentTransferEncoding(value: ContentEncoding): void

      Sets the Content-Transfer-Encoding value.

      Parameters

      Returns void

    • C#: MimeEntity.Load. Parses a MIME entity from a stream (or byte buffer), or — given an explicit Content-Type — from a bare content stream (the HttpWebResponse use-case, where headers are parsed separately). Parse errors are returned as an Err (C#: FormatException) per the port's Result convention.

      Parameters

      Returns Result<MimeEntity>

    • C#: MimeEntity.Load. Parses a MIME entity from a stream (or byte buffer), or — given an explicit Content-Type — from a bare content stream (the HttpWebResponse use-case, where headers are parsed separately). Parse errors are returned as an Err (C#: FormatException) per the port's Result convention.

      Parameters

      Returns Result<MimeEntity>

    • C#: MimeEntity.Load. Parses a MIME entity from a stream (or byte buffer), or — given an explicit Content-Type — from a bare content stream (the HttpWebResponse use-case, where headers are parsed separately). Parse errors are returned as an Err (C#: FormatException) per the port's Result convention.

      Parameters

      Returns Result<MimeEntity>

    • Calculates the best content-transfer-encoding for this part.

      Parameters

      • constraint: EncodingConstraint

        The encoding constraint.

      • maxLineLength: number = DEFAULT_MAX_LINE_LENGTH

        The maximum line length.

      Returns ContentEncoding

      The best content-transfer-encoding.

    • Computes a base64-encoded MD5 checksum for the decoded content.

      Returns string

      The computed checksum.

      The part has no content or has been disposed.

    • Verifies the Content-MD5 checksum against the decoded content.

      Returns boolean

      true if the checksum matches; otherwise false.

    • Prepares this part for transport under the requested encoding constraint.

      Parameters

      • constraint: EncodingConstraint

        The encoding constraint.

      • maxLineLength: number = DEFAULT_MAX_LINE_LENGTH

        The maximum encoded line length.

      Returns void

      maxLineLength is outside the supported range.

    • Parameters

      • action: "changed" | "removed" | "added" | "cleared"
      • header: Header | null

      Returns void