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

    Class TextPreviewerAbstract

    An abstract class for generating a text preview of a message.

    Hierarchy (View Summary)

    Index
    constructor
    inputFormat maximumPreviewLength
    getPreviewText getPreviewText getPreviewTextCore
    • get maximumPreviewLength(): number

      Gets or sets the maximum text preview length.

      The default value is 230, matching the value used by the Gmail web API.

      Returns number

      value is less than 1 or greater than 1024.

    • set maximumPreviewLength(value: number): void

      Parameters

      • value: number

      Returns void

    • Gets a text preview of a text part.

      Parameters

      Returns string

      A shortened preview of the original text.

      body is null or undefined.

    • Gets a text preview of a string of text.

      Parameters

      • text: string

        The original text.

      Returns string

      A shortened preview of the original text.

    • Gets a text preview of a stream of text in the specified charset.

      Parameters

      • stream: Stream

        The original text stream.

      • charset: string | CharsetEncoding

        The charset encoding of the stream.

      Returns string

      A shortened preview of the original text.

    • Gets a text preview of a string that has already been decoded.

      Parameters

      • text: string

        The original text.

      Returns string

      A shortened preview of the original text.

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods