Class TextPart

A MIME part containing text content.

TextPart handles plain text, flowed text, HTML, enriched text, and rich text bodies and decodes their content using the declared or detected charset.

Hierarchy (View Summary)

MimePart
- TextPart

Constructors

constructor

new TextPart(): TextPart
Initializes a new text part.

Returns TextPart

Throws
Constructor arguments are invalid.
Overrides MimePart.constructor
- Defined in src/text-part.ts:53
new TextPart(subtype: string, ...args: unknown[]): TextPart
Parameters
- subtype: string
- ...args: unknown[]
Returns TextPart
Overrides MimePart.constructor
- Defined in src/text-part.ts:54
new TextPart(format: TextFormat): TextPart
Parameters
- format: TextFormat
Returns TextPart
Overrides MimePart.constructor
- Defined in src/text-part.ts:55
new TextPart(contentType: ContentType): TextPart
Parameters
- contentType: ContentType
Returns TextPart
Overrides MimePart.constructor
- Defined in src/text-part.ts:56
new TextPart(args: MimeEntityConstructorArgs): TextPart
Parameters
- args: MimeEntityConstructorArgs
Returns TextPart
Overrides MimePart.constructor
- Defined in src/text-part.ts:57

Properties

`Readonly`headers

headers: HeaderList

The headers belonging to this MIME entity.

`Readonly`contentType

contentType: ContentType

The entity's Content-Type value.

ensureNewLine

ensureNewLine: boolean = false

`Protected` `Readonly`lazyLoaded

lazyLoaded: Set<LazyField> = ...

content

content: MimeContent | null = null

The MIME content for this part.

Accessors

isDisposed

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

Returns boolean
Inherited from MimePart.isDisposed
- Defined in src/mime-entity.ts:62

contentDisposition

get contentDisposition(): ContentDisposition | null
Gets or sets the Content-Disposition header value.

Returns ContentDisposition | null

Throws
The entity has been disposed.
Inherited from MimePart.contentDisposition
- Defined in src/mime-entity.ts:101
set contentDisposition(value: ContentDisposition | null): void
Sets the Content-Disposition header value.
Parameters
- value: ContentDisposition | null
Returns void
Inherited from MimePart.contentDisposition
- Defined in src/mime-entity.ts:118

contentBase

get contentBase(): string | null
Gets or sets the absolute Content-Base URI.

Returns string | null

Throws
value is not an absolute URI or the entity has been disposed.
Inherited from ApplicationPgpSignature.contentBase
- Defined in src/mime-entity.ts:139
set contentBase(value: string | URL | null): void
Sets the absolute Content-Base URI.
Parameters
- value: string | URL | null
Returns void
Inherited from ApplicationPgpSignature.contentBase
- Defined in src/mime-entity.ts:152

contentLocation

get contentLocation(): string | null
Gets or sets the Content-Location URI.

Returns string | null

Throws
The entity has been disposed.
Inherited from ApplicationPgpSignature.contentLocation
- Defined in src/mime-entity.ts:167
set contentLocation(value: string | URL | null): void
Sets the Content-Location URI.
Parameters
- value: string | URL | null
Returns void
Inherited from ApplicationPgpSignature.contentLocation
- Defined in src/mime-entity.ts:180

contentId

get contentId(): string | null
Gets or sets the Content-Id header value.

Returns string | null

Throws
value is not a valid message id or the entity has been disposed.
Inherited from ApplicationPgpSignature.contentId
- Defined in src/mime-entity.ts:193
set contentId(value: string | null): void
Sets the Content-Id header value.
Parameters
- value: string | null
Returns void
Inherited from ApplicationPgpSignature.contentId
- Defined in src/mime-entity.ts:209

isAttachment

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
Inherited from MimePart.isAttachment
- Defined in src/mime-entity.ts:233
set isAttachment(value: boolean): void
Sets whether this entity is marked as an attachment.
Parameters
- value: boolean
Returns void
Inherited from MimePart.isAttachment
- Defined in src/mime-entity.ts:239

contentDescription

get contentDescription(): string | null
Gets or sets the Content-Description header value.

Returns string | null

Throws
The part has been disposed.
Inherited from MimePart.contentDescription
- Defined in src/mime-part.ts:98
set contentDescription(value: string | null): void
Sets the Content-Description header value.
Parameters
- value: string | null
Returns void
Inherited from MimePart.contentDescription
- Defined in src/mime-part.ts:110

contentDuration

get contentDuration(): number | null
Gets or sets the Content-Duration value in seconds.

Returns number | null

Throws
value is not a non-negative integer.

Throws
The part has been disposed.
Inherited from MimePart.contentDuration
- Defined in src/mime-part.ts:123
set contentDuration(value: number | null): void
Sets the Content-Duration value in seconds.
Parameters
- value: number | null
Returns void
Inherited from MimePart.contentDuration
- Defined in src/mime-part.ts:136

contentMd5

get contentMd5(): string | null
Gets or sets the Content-MD5 checksum value.

Returns string | null

Throws
The part has been disposed.
Inherited from MimePart.contentMd5
- Defined in src/mime-part.ts:150
set contentMd5(value: string | null): void
Sets the Content-MD5 checksum value.
Parameters
- value: string | null
Returns void
Inherited from MimePart.contentMd5
- Defined in src/mime-part.ts:162

contentTransferEncoding

get contentTransferEncoding(): ContentEncoding
Gets or sets the Content-Transfer-Encoding value.

Returns ContentEncoding

Throws
value is not a valid content encoding or the part has been disposed.
Inherited from MimePart.contentTransferEncoding
- Defined in src/mime-part.ts:174
set contentTransferEncoding(value: ContentEncoding): void
Sets the Content-Transfer-Encoding value.
Parameters
- value: ContentEncoding
Returns void
Inherited from MimePart.contentTransferEncoding
- Defined in src/mime-part.ts:189

fileName

get fileName(): string | null
Gets or sets the file name from Content-Disposition or Content-Type.

Returns string | null
Inherited from ApplicationPgpSignature.fileName
- Defined in src/mime-part.ts:200
set fileName(value: string | null): void
Sets the file name in Content-Disposition and Content-Type.
Parameters
- value: string | null
Returns void
Inherited from ApplicationPgpSignature.fileName
- Defined in src/mime-part.ts:205

format

get format(): TextFormat
Gets the best matching text format for this part.

Returns TextFormat
- Defined in src/text-part.ts:104

isEnriched

get isEnriched(): boolean
Gets whether this part is text/enriched or text/richtext.

Returns boolean
- Defined in src/text-part.ts:125

isFlowed

get isFlowed(): boolean
Gets whether this part is flowed plain text.

Returns boolean
- Defined in src/text-part.ts:131

isHtml

get isHtml(): boolean
Gets whether this part is HTML text.

Returns boolean
- Defined in src/text-part.ts:136

isPlain

get isPlain(): boolean
Gets whether this part is plain text.

Returns boolean
- Defined in src/text-part.ts:142

isRichText

get isRichText(): boolean
Gets whether this part is rich text.

Returns boolean
- Defined in src/text-part.ts:148

text

get text(): string
Gets or sets the decoded text using UTF-8 when setting.

Returns string
- Defined in src/text-part.ts:166
set text(value: string): void
Sets the text content using UTF-8.
Parameters
- value: string
Returns void
- Defined in src/text-part.ts:171

Methods

toString

toString(): string
Serializes the MIME entity to a string.

Returns string
The serialized MIME entity.
Inherited from MimePart.toString
- Defined in src/mime-entity.ts:298

`Protected`checkDisposed

checkDisposed(objectName?: string): void
Parameters
- objectName: string = 'MimeEntity'
Returns void
Inherited from MimePart.checkDisposed
- Defined in src/mime-entity.ts:315

`Protected`tryInit

tryInit(obj: unknown): boolean
Parameters
- obj: unknown
Returns boolean
Inherited from MimePart.tryInit
- Defined in src/mime-entity.ts:320

`Protected`removeHeader

removeHeader(name: string): void
Parameters
- name: string
Returns void
Inherited from MimePart.removeHeader
- Defined in src/mime-entity.ts:333

`Protected`setHeader

setHeader(name: string, value: string): void
Parameters
- name: string
- value: string
Returns void
Inherited from MimePart.setHeader
- Defined in src/mime-entity.ts:343

`Protected`setRawHeader

setRawHeader(name: string, rawValue: Uint8Array): void
Parameters
- name: string
- rawValue: Uint8Array
Returns void
Inherited from MimePart.setRawHeader
- Defined in src/mime-entity.ts:353

`Static`load

load(
    stream: Stream,
    persistent?: boolean,
    options?: ParserOptions,
): 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
- stream: Stream
- Optionalpersistent: boolean
- Optionaloptions: ParserOptions
Returns Result<MimeEntity>
Inherited from MimePart.load
- Defined in src/mime-entity.ts:416
load(data: Uint8Array, options?: ParserOptions): 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
- data: Uint8Array
- Optionaloptions: ParserOptions
Returns Result<MimeEntity>
Inherited from MimePart.load
- Defined in src/mime-entity.ts:417
load(
    contentType: ContentType,
    content: Stream,
    options?: ParserOptions,
): 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
- contentType: ContentType
- content: Stream
- Optionaloptions: ParserOptions
Returns Result<MimeEntity>
Inherited from MimePart.load
- Defined in src/mime-entity.ts:418

getBestEncoding

getBestEncoding(
constraint: EncodingConstraint,
maxLineLength?: number,
): ContentEncoding
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.
Inherited from MimePart.getBestEncoding
- Defined in src/mime-part.ts:222

computeContentMd5

computeContentMd5(): string
Computes a base64-encoded MD5 checksum for the decoded content.

Returns string
The computed checksum.

Throws
The part has no content or has been disposed.
Inherited from MimePart.computeContentMd5
- Defined in src/mime-part.ts:244

verifyContentMd5

verifyContentMd5(): boolean
Verifies the Content-MD5 checksum against the decoded content.

Returns boolean
true if the checksum matches; otherwise false.
Inherited from MimePart.verifyContentMd5
- Defined in src/mime-part.ts:263

prepare

prepare(constraint: EncodingConstraint, maxLineLength?: number): void
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

Throws
maxLineLength is outside the supported range.
Inherited from MimePart.prepare
- Defined in src/mime-part.ts:290

writeTo

writeTo(stream: Stream): void
Writes the MIME part to a stream.
Parameters
- stream: Stream
  The destination stream.
Returns void
Inherited from MimePart.writeTo
- Defined in src/mime-part.ts:321
writeTo(options: FormatOptions, stream: Stream): void
Writes the MIME part to a stream.
Parameters
- options: FormatOptions
  Formatting options.
- stream: Stream
  The destination stream.
Returns void
Inherited from MimePart.writeTo
- Defined in src/mime-part.ts:322
writeTo(options: FormatOptions, stream: Stream, contentOnly: boolean): void
Writes the MIME part to a stream.
Parameters
- options: FormatOptions
  Formatting options.
- stream: Stream
  The destination stream.
- contentOnly: boolean
  Whether to omit the part headers.
Returns void
Inherited from MimePart.writeTo
- Defined in src/mime-part.ts:323

`Protected`onHeadersChanged

onHeadersChanged(
action: "changed" | "removed" | "added" | "cleared",
header: Header | null,
): void
Parameters
- action: "changed" | "removed" | "added" | "cleared"
- header: Header | null
Returns void
Inherited from MimePart.onHeadersChanged
- Defined in src/mime-part.ts:369

dispose

dispose(): void
Releases the content and base entity resources.

Returns void
Inherited from MimePart.dispose
- Defined in src/mime-part.ts:402

accept

accept(visitor: MimeVisitor): void
Dispatches to the visitor method for text parts.
Parameters
- visitor: MimeVisitor
  The visitor.
Returns void
Overrides MimePart.accept
- Defined in src/text-part.ts:158

isFormat

isFormat(format: TextFormat): boolean
Tests whether this part matches a text format.
Parameters
- format: TextFormat
  The format to test.
Returns boolean
true if this part matches format; otherwise false.
- Defined in src/text-part.ts:181

tryDetectEncoding

tryDetectEncoding(): | {
    ok: true;
    encoding: CharsetEncoding;
    confidence: TextEncodingConfidence;
}
| { ok: false; encoding: null; confidence: TextEncodingConfidence }
Attempts to detect the charset encoding used by the content.

Returns
    | {
        ok: true;
        encoding: CharsetEncoding;
        confidence: TextEncodingConfidence;
    }
    | { ok: false; encoding: null; confidence: TextEncodingConfidence }
The detected encoding and confidence, or an undefined confidence.
- Defined in src/text-part.ts:197

getText

getText(): { text: string; encoding: CharsetEncoding }
Gets the decoded text.

Returns { text: string; encoding: CharsetEncoding }
The decoded text, or the decoded text with the detected encoding.

Throws
The charset is unsupported or the part has been disposed.
- Defined in src/text-part.ts:228
getText(encoding: CharsetEncoding): string
Gets the decoded text.
Parameters
- encoding: CharsetEncoding
  The encoding to use.
Returns string
The decoded text, or the decoded text with the detected encoding.

Throws
The charset is unsupported or the part has been disposed.
- Defined in src/text-part.ts:229
getText(charset: string): string
Gets the decoded text.
Parameters
- charset: string
  The charset name to use.
Returns string
The decoded text, or the decoded text with the detected encoding.

Throws
The charset is unsupported or the part has been disposed.
- Defined in src/text-part.ts:230

setText

setText(charset: string | CharsetEncoding, text: string): void
Sets the text content using the specified charset.
Parameters
- charset: string | CharsetEncoding
  The charset name or encoding.
- text: string
  The text content.
Returns void

Throws
charset or text is null, or the charset is unsupported.
- Defined in src/text-part.ts:257

Class TextPart

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TextPart

Throws

Parameters

Returns TextPart

Parameters

Returns TextPart

Parameters

Returns TextPart

Parameters

Returns TextPart

Properties

Readonlyheaders

ReadonlycontentType

ensureNewLine

Protected ReadonlylazyLoaded

content

Accessors

isDisposed

Returns boolean

contentDisposition

Returns ContentDisposition | null

Throws

Parameters

Returns void

contentBase

Returns string | null

Throws

Parameters

Returns void

contentLocation

Returns string | null

Throws

Parameters

Returns void

contentId

Returns string | null

Throws

Parameters

Returns void

isAttachment

Returns boolean

Parameters

Returns void

contentDescription

Returns string | null

Throws

Parameters

Returns void

contentDuration

Returns number | null

Throws

Throws

Parameters

Returns void

contentMd5

Returns string | null

Throws

Parameters

Returns void

contentTransferEncoding

Returns ContentEncoding

Throws

Parameters

Returns void

fileName

Returns string | null

Parameters

Returns void

format

Returns TextFormat

isEnriched

`Readonly`headers

`Readonly`contentType

`Protected` `Readonly`lazyLoaded

`Protected`checkDisposed

`Protected`tryInit

`Protected`removeHeader

`Protected`setHeader

`Protected`setRawHeader

`Static`load

`Protected`onHeadersChanged

Returns
| {
ok: true;
encoding: CharsetEncoding;
confidence: TextEncodingConfidence;
}
| { ok: false; encoding: null; confidence: TextEncodingConfidence }