Class PlainTextPreviewer

A text previewer for plain text.

Hierarchy (View Summary)

TextPreviewer
- PlainTextPreviewer

Index

Constructors

Accessors

inputFormat maximumPreviewLength

Methods

getPreviewText getPreviewTextCore getPreviewText

Constructors

constructor

new PlainTextPreviewer(): PlainTextPreviewer

Returns PlainTextPreviewer

Inherited from TextPreviewer.constructor

Accessors

inputFormat

get inputFormat(): TextFormat
The input format.

Returns TextFormat
Overrides TextPreviewer.inputFormat
- Defined in src/text/plain-text-previewer.ts:12

maximumPreviewLength

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

Throws
value is less than 1 or greater than 1024.
Inherited from TextPreviewer.maximumPreviewLength
- Defined in src/text/text-previewer.ts:63
set maximumPreviewLength(value: number): void
Parameters
- value: number
Returns void
Inherited from TextPreviewer.maximumPreviewLength
- Defined in src/text/text-previewer.ts:64

Methods

`Static`getPreviewText

getPreviewText(body: TextPart): string
Gets a text preview of a text part.
Parameters
- body: TextPart
  The text part.
Returns string
A shortened preview of the original text.

Throws
body is null or undefined.
Inherited from TextPreviewer.getPreviewText
- Defined in src/text/text-previewer.ts:76

`Protected`getPreviewTextCore

getPreviewTextCore(text: string): string
Gets a text preview of a string of text.
Parameters
- text: string
  The original text.
Returns string
A shortened preview of the original text.
Overrides TextPreviewer.getPreviewTextCore
- Defined in src/text/plain-text-previewer.ts:20

getPreviewText

getPreviewText(text: string): string
Gets a text preview of a string of text.
Parameters
- text: string
  The original text.
Returns string
A shortened preview of the original text.
Inherited from TextPreviewer.getPreviewText
- Defined in src/text/text-previewer.ts:103
getPreviewText(stream: Stream, charset: string | CharsetEncoding): string
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.
Inherited from TextPreviewer.getPreviewText
- Defined in src/text/text-previewer.ts:111