Class MultipartRelated

A multipart/related MIME entity.

A multipart/related entity contains inter-related MIME parts that typically reference each other via Content-Id or Content-Location URIs.

Hierarchy (View Summary)

Multipart
- MultipartRelated

Constructors

constructor

new MultipartRelated(...args: unknown[]): MultipartRelated
Initializes a new multipart/related entity.
Parameters
- ...args: unknown[]
  Initialization arguments: headers and MIME entities.
Returns MultipartRelated
Overrides Multipart.constructor
- Defined in src/multipart-related.ts:21
new MultipartRelated(args: MimeEntityConstructorArgs): MultipartRelated
Parameters
- args: MimeEntityConstructorArgs
Returns MultipartRelated
Overrides Multipart.constructor
- Defined in src/multipart-related.ts:22

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> = ...

rawBoundaries

rawBoundaries: (Uint8Array<ArrayBufferLike> | null)[] | null = null

Raw boundary bytes preserved from parsing, one entry per child.

rawPreamble

rawPreamble: Uint8Array<ArrayBufferLike> | null = null

Raw preamble bytes preserved from parsing.

rawEndBoundary

rawEndBoundary: Uint8Array<ArrayBufferLike> | null = null

Raw closing boundary bytes preserved from parsing.

rawEpilogue

rawEpilogue: Uint8Array<ArrayBufferLike> | null = null

Raw epilogue bytes preserved from parsing.

Accessors

isDisposed

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

Returns boolean
Inherited from Multipart.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 Multipart.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 Multipart.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 Multipart.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 Multipart.isAttachment
- Defined in src/mime-entity.ts:239

Root

get Root(): MimeEntity | null
Gets or sets the root document of the multipart/related entity.

Returns MimeEntity | null
- Defined in src/multipart-related.ts:32
set Root(value: MimeEntity | null): void
Sets the root document of the multipart/related entity.
Parameters
- value: MimeEntity | null
Returns void
- Defined in src/multipart-related.ts:34

root

get root(): MimeEntity | null
Gets or sets the root document of the multipart/related entity.

Returns MimeEntity | null
- Defined in src/multipart-related.ts:36
set root(value: MimeEntity | null): void
Sets the root document of the multipart/related entity.
Parameters
- value: MimeEntity | null
Returns void
- Defined in src/multipart-related.ts:43

Boundary

get Boundary(): string | null
Gets or sets the boundary parameter.

Returns string | null
Inherited from Multipart.Boundary
- Defined in src/multipart.ts:90
set Boundary(value: string | null): void
Sets the boundary parameter.
Parameters
- value: string | null
Returns void
Inherited from Multipart.Boundary
- Defined in src/multipart.ts:92

boundary

get boundary(): string | null
Gets or sets the boundary parameter.

Returns string | null
Inherited from Multipart.boundary
- Defined in src/multipart.ts:94
set boundary(value: string | null): void
Sets the boundary parameter.
Parameters
- value: string | null
Returns void
Inherited from Multipart.boundary
- Defined in src/multipart.ts:96

Preamble

get Preamble(): string | null
Gets or sets the multipart preamble.

Returns string | null
Inherited from Multipart.Preamble
- Defined in src/multipart.ts:104
set Preamble(value: string | null): void
Sets the multipart preamble.
Parameters
- value: string | null
Returns void
Inherited from Multipart.Preamble
- Defined in src/multipart.ts:106

preamble

get preamble(): string | null
Gets or sets the multipart preamble.

Returns string | null
Inherited from Multipart.preamble
- Defined in src/multipart.ts:108
set preamble(value: string | null): void
Sets the multipart preamble.
Parameters
- value: string | null
Returns void
Inherited from Multipart.preamble
- Defined in src/multipart.ts:114

Epilogue

get Epilogue(): string | null
Gets or sets the multipart epilogue.

Returns string | null
Inherited from Multipart.Epilogue
- Defined in src/multipart.ts:128
set Epilogue(value: string | null): void
Sets the multipart epilogue.
Parameters
- value: string | null
Returns void
Inherited from Multipart.Epilogue
- Defined in src/multipart.ts:130

epilogue

get epilogue(): string | null
Gets or sets the multipart epilogue.

Returns string | null
Inherited from Multipart.epilogue
- Defined in src/multipart.ts:132
set epilogue(value: string | null): void
Sets the multipart epilogue.
Parameters
- value: string | null
Returns void
Inherited from Multipart.epilogue
- Defined in src/multipart.ts:146

WriteEndBoundary

get WriteEndBoundary(): boolean
Gets whether an end boundary should be written.

Returns boolean
Inherited from Multipart.WriteEndBoundary
- Defined in src/multipart.ts:162

writeEndBoundary

get writeEndBoundary(): boolean
Gets whether an end boundary should be written.

Returns boolean
Inherited from Multipart.writeEndBoundary
- Defined in src/multipart.ts:164

Count

get Count(): number
Gets the number of child MIME entities.

Returns number
Inherited from Multipart.Count
- Defined in src/multipart.ts:166

count

get count(): number
Gets the number of child MIME entities.

Returns number
Inherited from Multipart.count
- Defined in src/multipart.ts:168

IsReadOnly

get IsReadOnly(): boolean
Gets whether the collection is read-only.

Returns boolean
Inherited from Multipart.IsReadOnly
- Defined in src/multipart.ts:170

isReadOnly

get isReadOnly(): boolean
Gets whether the collection is read-only.

Returns boolean
Inherited from Multipart.isReadOnly
- Defined in src/multipart.ts:172

Methods

toString

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

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

`Protected`checkDisposed

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

`Protected`tryInit

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

`Protected`removeHeader

removeHeader(name: string): void
Parameters
- name: string
Returns void
Inherited from Multipart.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 Multipart.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 Multipart.setRawHeader
- Defined in src/mime-entity.ts:353

`Protected`onHeadersChanged

onHeadersChanged(action: HeaderListChangedAction, header: Header | null): void
Parameters
- action: HeaderListChangedAction
- header: Header | null
Returns void
Inherited from Multipart.onHeadersChanged
- Defined in src/mime-entity.ts:363

`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 Multipart.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 Multipart.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 Multipart.load
- Defined in src/mime-entity.ts:418

accept

accept(visitor: MimeVisitor): void
Dispatches to the visitor method for multipart/related entities.
Parameters
- visitor: MimeVisitor
  The visitor.
Returns void
Overrides Multipart.accept
- Defined in src/multipart-related.ts:73

tryGetValue

tryGetValue(format: TextFormat): TextPart | null
Finds the preferred text part in the root document.
Parameters
- format: TextFormat
  The preferred text format.
Returns TextPart | null
The matching text part, or null.
Overrides Multipart.tryGetValue
- Defined in src/multipart-related.ts:85

containsUri

containsUri(uri: string | URL): boolean
Tests whether a linked resource URI exists.
Parameters
- uri: string | URL
  The resource URI.
Returns boolean
true if the URI resolves to a child entity; otherwise false.
- Defined in src/multipart-related.ts:100

indexOfUri

indexOfUri(uri: string | URL): number
Gets the index of the entity referenced by a URI.
Parameters
- uri: string | URL
  The resource URI.
Returns number
The zero-based index, or -1 if not found.
- Defined in src/multipart-related.ts:110

open

open(uri: string | URL): Stream
Opens the content stream for a linked resource URI.
Parameters
- uri: string | URL
  The resource URI.
Returns Stream
The decoded resource stream.
- Defined in src/multipart-related.ts:154

openWithInfo

openWithInfo(
uri: string | URL,
): { stream: Stream; mimeType: string; charset: string | null }
Opens a linked resource and returns stream metadata.
Parameters
- uri: string | URL
  The resource URI.
Returns { stream: Stream; mimeType: string; charset: string | null }
The decoded stream, MIME type, and charset.
- Defined in src/multipart-related.ts:170

at

at(index: number): MimeEntity
Gets the child entity at the specified index.
Parameters
- index: number
  The zero-based child index.
Returns MimeEntity
The child entity.

Throws
index is out of range.
Inherited from Multipart.at
- Defined in src/multipart.ts:181

set

set(index: number, entity: MimeEntity): void
Replaces the child entity at the specified index.
Parameters
- index: number
  The zero-based child index.
- entity: MimeEntity
  The replacement entity.
Returns void
Inherited from Multipart.set
- Defined in src/multipart.ts:192

add

add(entity: MimeEntity): void
Adds a child MIME entity.
Parameters
- entity: MimeEntity
  The entity to add.
Returns void
Inherited from Multipart.add
- Defined in src/multipart.ts:203

addInternal

addInternal(
entity: MimeEntity,
boundary: Uint8Array<ArrayBufferLike> | null,
): void
Adds a child entity with its raw boundary as parsed.
Parameters
- entity: MimeEntity
  The entity to add.
- boundary: Uint8Array<ArrayBufferLike> | null
  The raw boundary bytes.
Returns void
Inherited from Multipart.addInternal
- Defined in src/multipart.ts:215

clear

clear(dispose?: boolean): void
Removes all child entities.
Parameters
- dispose: boolean = false
  Whether to dispose removed children.
Returns void
Inherited from Multipart.clear
- Defined in src/multipart.ts:226

contains

contains(entity: MimeEntity): boolean
Tests whether a child entity is present.
Parameters
- entity: MimeEntity
  The entity to locate.
Returns boolean
true if the entity is present; otherwise false.
Inherited from Multipart.contains
- Defined in src/multipart.ts:242

copyTo

copyTo(array: MimeEntity[], arrayIndex: number): void
Copies child entities into an array.
Parameters
- array: MimeEntity[]
  The destination array.
- arrayIndex: number
  The starting index in array.
Returns void
Inherited from Multipart.copyTo
- Defined in src/multipart.ts:253

remove

remove(entity: MimeEntity): boolean
Removes a child MIME entity.
Parameters
- entity: MimeEntity
  The entity to remove.
Returns boolean
true if the entity was removed; otherwise false.
Inherited from Multipart.remove
- Defined in src/multipart.ts:269

indexOf

indexOf(entity: MimeEntity): number
Gets the index of a child entity.
Parameters
- entity: MimeEntity
  The entity to locate.
Returns number
The zero-based index, or -1 if not found.
Inherited from Multipart.indexOf
- Defined in src/multipart.ts:285

insert

insert(index: number, entity: MimeEntity): void
Inserts a child entity at the specified index.
Parameters
- index: number
  The insertion index.
- entity: MimeEntity
  The entity to insert.
Returns void
Inherited from Multipart.insert
- Defined in src/multipart.ts:296

removeAt

removeAt(index: number): void
Removes the child entity at the specified index.
Parameters
- index: number
  The zero-based child index.
Returns void
Inherited from Multipart.removeAt
- Defined in src/multipart.ts:309

`Static`foldPreambleOrEpilogue

foldPreambleOrEpilogue(
    options: FormatOptions,
    text: string,
    isEpilogue: boolean,
): string
Folds preamble or epilogue text for serialization.
Parameters
- options: FormatOptions
  Formatting options.
- text: string
  The text to fold.
- isEpilogue: boolean
  Whether the text is an epilogue.
Returns string
Folded text.
Inherited from Multipart.foldPreambleOrEpilogue
- Defined in src/multipart.ts:355

prepare

prepare(constraint: EncodingConstraint, maxLineLength?: number): void
Prepares each child entity for transport.
Parameters
- constraint: EncodingConstraint
  The encoding constraint.
- maxLineLength: number = 78
  The maximum encoded line length.
Returns void
Inherited from Multipart.prepare
- Defined in src/multipart.ts:399

writeTo

writeTo(a: FormatOptions | Stream, b?: Stream, contentOnly?: boolean): void
Writes the multipart entity to a stream.
Parameters
- a: FormatOptions | Stream
- Optionalb: Stream
- contentOnly: boolean = false
  Whether to omit the multipart headers.
Returns void
Inherited from Multipart.writeTo
- Defined in src/multipart.ts:414

[iterator]

"[iterator]"(): Iterator<MimeEntity>
Returns an iterator over the child MIME entities.

Returns Iterator<MimeEntity>
Inherited from Multipart.[iterator]
- Defined in src/multipart.ts:462

dispose

dispose(): void
Disposes the multipart and all child entities.

Returns void
Inherited from Multipart.dispose
- Defined in src/multipart.ts:467

Class MultipartRelated

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MultipartRelated

Parameters

Returns MultipartRelated

Properties

Readonlyheaders

ReadonlycontentType

ensureNewLine

Protected ReadonlylazyLoaded

rawBoundaries

rawPreamble

rawEndBoundary

rawEpilogue

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

Root

Returns MimeEntity | null

Parameters

Returns void

root

Returns MimeEntity | null

Parameters

Returns void

Boundary

Returns string | null

Parameters

Returns void

boundary

Returns string | null

Parameters

Returns void

Preamble

Returns string | null

Parameters

Returns void

preamble

Returns string | null

Parameters

Returns void

Epilogue

Returns string | null

Parameters

Returns void

epilogue

Returns string | null

Parameters

`Readonly`headers

`Readonly`contentType

`Protected` `Readonly`lazyLoaded

`Protected`checkDisposed

`Protected`tryInit

`Protected`removeHeader

`Protected`setHeader

`Protected`setRawHeader

`Protected`onHeadersChanged

`Static`load