Class MimeMessage

constructor

• new MimeMessage(): MimeMessage

  Initializes a new MIME message.

  Returns MimeMessage

• new MimeMessage(headers: Iterable<Header>): MimeMessage

  Parameters

  • headers: Iterable<Header>

  Returns MimeMessage

• new MimeMessage(
      from: Iterable<InternetAddress>,
      to: Iterable<InternetAddress>,
      subject: string,
      body: MimeEntity | null,
  ): MimeMessage

  Parameters

  • from: Iterable<InternetAddress>
  • to: Iterable<InternetAddress>
  • subject: string
  • body: MimeEntity | null

  Returns MimeMessage

• new MimeMessage(...args: unknown[]): MimeMessage

  Parameters

  • ...args: unknown[]

  Returns MimeMessage

• new MimeMessage(
      options: ParserOptions,
      headers: Iterable<Header>,
      mode: RfcComplianceMode,
  ): MimeMessage

  C#: internal MimeMessage (ParserOptions options, IEnumerable

  headers, RfcComplianceMode mode).

  Parameters

  • options: ParserOptions
  • headers: Iterable<Header>
  • mode: RfcComplianceMode

  Returns MimeMessage

• new MimeMessage(...args: unknown[]): MimeMessage

  Parameters

  • ...args: unknown[]

  Returns MimeMessage

Readonlyheaders

Readonlycompliance

mboxMarker

body

importance

• get importance(): MessageImportance

  Gets or sets the message importance.

  Returns MessageImportance

• set importance(value: MessageImportance): void

  Sets the message importance.

  Parameters

  • value: MessageImportance

  Returns void

priority

• get priority(): MessagePriority

  Gets or sets the message priority.

  Returns MessagePriority

• set priority(value: MessagePriority): void

  Sets the message priority.

  Parameters

  • value: MessagePriority

  Returns void

xPriority

• get xPriority(): XMessagePriority

  Gets or sets the X-Priority value.

  Returns XMessagePriority

• set xPriority(value: XMessagePriority): void

  Sets the X-Priority value.

  Parameters

  • value: XMessagePriority

  Returns void

sender

• get sender(): MailboxAddress | null

  Gets or sets the Sender mailbox.

  Returns MailboxAddress | null

• set sender(value: MailboxAddress | null): void

  Sets the Sender mailbox.

  Parameters

  • value: MailboxAddress | null

  Returns void

resentSender

• get resentSender(): MailboxAddress | null

  Gets or sets the Resent-Sender mailbox.

  Returns MailboxAddress | null

• set resentSender(value: MailboxAddress | null): void

  Sets the Resent-Sender mailbox.

  Parameters

  • value: MailboxAddress | null

  Returns void

from

• get from(): InternetAddressList

  Gets the From address list.

  Returns InternetAddressList

resentFrom

• get resentFrom(): InternetAddressList

  Gets the Resent-From address list.

  Returns InternetAddressList

replyTo

• get replyTo(): InternetAddressList

  Gets the Reply-To address list.

  Returns InternetAddressList

resentReplyTo

• get resentReplyTo(): InternetAddressList

  Gets the Resent-Reply-To address list.

  Returns InternetAddressList

to

• get to(): InternetAddressList

  Gets the To address list.

  Returns InternetAddressList

resentTo

• get resentTo(): InternetAddressList

  Gets the Resent-To address list.

  Returns InternetAddressList

cc

• get cc(): InternetAddressList

  Gets the Cc address list.

  Returns InternetAddressList

resentCc

• get resentCc(): InternetAddressList

  Gets the Resent-Cc address list.

  Returns InternetAddressList

bcc

• get bcc(): InternetAddressList

  Gets the Bcc address list.

  Returns InternetAddressList

resentBcc

• get resentBcc(): InternetAddressList

  Gets the Resent-Bcc address list.

  Returns InternetAddressList

subject

• get subject(): string | null

  Gets or sets the message subject.

  Returns string | null

• set subject(value: string): void

  Sets the message subject.

  Parameters

  • value: string

  Returns void

date

• get date(): DateTimeOffset

  Gets or sets the Date header value.

  Returns DateTimeOffset

• set date(value: DateTimeOffset): void

  Sets the Date header value.

  Parameters

  • value: DateTimeOffset

  Returns void

resentDate

• get resentDate(): DateTimeOffset

  Gets or sets the Resent-Date header value.

  Returns DateTimeOffset

• set resentDate(value: DateTimeOffset): void

  Sets the Resent-Date header value.

  Parameters

  • value: DateTimeOffset

  Returns void

references

• get references(): MessageIdList

  Gets the References message id list.

  Returns MessageIdList

inReplyTo

• get inReplyTo(): string | null

  Gets or sets the In-Reply-To message id.

  Returns string | null

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

  Sets the In-Reply-To message id.

  Parameters

  • value: string | null

  Returns void

messageId

• get messageId(): string | null

  Gets or sets the Message-Id value.

  Returns string | null

• set messageId(value: string): void

  Sets the Message-Id value.

  Parameters

  • value: string

  Returns void

resentMessageId

• get resentMessageId(): string | null

  Gets or sets the Resent-Message-Id value.

  Returns string | null

• set resentMessageId(value: string): void

  Sets the Resent-Message-Id value.

  Parameters

  • value: string

  Returns void

mimeVersion

• get mimeVersion(): Version | null

  Gets or sets the MIME-Version header value.

  Returns Version | null

• set mimeVersion(value: Version): void

  Sets the MIME-Version header value.

  Parameters

  • value: Version

  Returns void

textBody

• get textBody(): string | null

  Gets the plain text body, if present.

  Returns string | null

htmlBody

• get htmlBody(): string | null

  Gets the HTML body, if present.

  Returns string | null

bodyParts

• get bodyParts(): IterableIterator<MimeEntity>

  Enumerates all body parts recursively.

  Returns IterableIterator<MimeEntity>

attachments

• get attachments(): IterableIterator<MimeEntity>

  Enumerates attachment body parts recursively.

  Returns IterableIterator<MimeEntity>

getTextBody

• getTextBody(format: TextFormat): string | null

  Gets the body text for a preferred format.

  Parameters

  • format: TextFormat

    The preferred text format.

  Returns string | null

  The body text, or null if not available.

getRecipients

• getRecipients(onlyUnique?: boolean): MailboxAddress[]

  Gets all message recipients.

  Parameters

  • onlyUnique: boolean = false

    Whether to return only unique mailbox addresses.

  Returns MailboxAddress[]

  The recipient mailboxes.

getMessageSigner

• getMessageSigner(): MailboxAddress | null

  Gets the mailbox that should be used as the signer when signing the message.

  C#: MimeMessage.GetMessageSigner. If either of the Resent-Sender or Resent-From headers are set, the Resent-Sender (or first Resent-From mailbox) is used; otherwise the Sender or first From mailbox is used.

  Returns MailboxAddress | null

  The signer mailbox, or null if no sender has been set.

getEncryptionRecipients

• getEncryptionRecipients(): MailboxAddress[]

  Gets the set of mailboxes a message should be encrypted to.

  C#: MimeMessage.GetEncryptionRecipients — the signer(s) plus every recipient (To/Cc/Bcc, or the Resent-* equivalents), de-duplicated.

  Returns MailboxAddress[]

  The unique recipient mailboxes.

accept

• accept(visitor: MimeVisitor): void

  Dispatches to the visitor method for MIME messages.

  Parameters

  • visitor: MimeVisitor

    The visitor.

  Returns void

prepare

• prepare(constraint: EncodingConstraint, maxLineLength?: number): void

  Prepares the message body for transport.

  Parameters

  • constraint: EncodingConstraint

    The encoding constraint.

  • maxLineLength: number = 78

    The maximum encoded line length.

  Returns void

writeTo

• writeTo(stream: Stream): void

  Writes the message to a stream.

  Parameters

  • stream: Stream

    The destination stream.

  Returns void

• writeTo(stream: Stream, headersOnly: boolean): void

  Writes the message to a stream.

  Parameters

  • stream: Stream

    The destination stream.

  • headersOnly: boolean

    Whether to write only headers.

  Returns void

• writeTo(options: FormatOptions, stream: Stream): void

  Writes the message to a stream.

  Parameters

  • options: FormatOptions

    Formatting options.

  • stream: Stream

    The destination stream.

  Returns void

• writeTo(options: FormatOptions, stream: Stream, headersOnly: boolean): void

  Writes the message to a stream.

  Parameters

  • options: FormatOptions

    Formatting options.

  • stream: Stream

    The destination stream.

  • headersOnly: boolean

    Whether to write only headers.

  Returns void

toString

• toString(): string

  Serializes the message to a string.

  Returns string

  The serialized message.

Staticload

• load(
      stream: Stream,
      persistent?: boolean,
      options?: ParserOptions,
  ): Result<MimeMessage>

  Loads a MIME message from bytes or a stream.

  Parameters

  • stream: Stream

    The input stream.

  • Optionalpersistent: boolean

    Whether parsed content should reference the source stream.

  • Optionaloptions: ParserOptions

    Parser options.

  Returns Result<MimeMessage>

  A Result; { ok: false } with a MimeError on malformed input.

• load(data: Uint8Array, options?: ParserOptions): Result<MimeMessage>

  Loads a MIME message from bytes or a stream.

  Parameters

  • data: Uint8Array

    The input bytes.

  • Optionaloptions: ParserOptions

    Parser options.

  Returns Result<MimeMessage>

  A Result; { ok: false } with a MimeError on malformed input.

dispose

• dispose(): void

  Releases resources owned by the message body and header lists.

  Returns void

StaticmergeHeaders

• mergeHeaders(headers: HeaderList, body: MimeEntity): IterableIterator<Header>

  Merges message headers with body entity headers for serialization.

  Parameters

  • headers: HeaderList

    The message headers.

  • body: MimeEntity

    The message body.

  Returns IterableIterator<Header>

  The merged headers.

sign

• sign(ctx: CryptographyContext, digestAlgo?: DigestAlgorithm): Promise<void>

  Sign the message body in place using the specified S/MIME or OpenPGP context.

  The signer is resolved from the message's Resent-Sender/Resent-From or Sender/From address; the body is replaced with a multipart/signed.

  Parameters

  • ctx: CryptographyContext

    The cryptography context.

  • OptionaldigestAlgo: DigestAlgorithm

    The digest algorithm (defaults to SHA-1, matching C#).

  Returns Promise<void>

encrypt

• encrypt(ctx: CryptographyContext): Promise<void>

  Encrypt the message body in place to the sender and all recipients. The body is replaced with an application/pkcs7-mime (S/MIME) or multipart/encrypted (PGP/MIME) part, depending on the context.

  Parameters

  • ctx: CryptographyContext

    The cryptography context.

  Returns Promise<void>

signAndEncrypt

• signAndEncrypt(
      ctx: CryptographyContext,
      digestAlgo?: DigestAlgorithm,
  ): Promise<void>

  Sign and then encrypt the message body in place using the specified context.

  Parameters

  • ctx: CryptographyContext

    The cryptography context.

  • OptionaldigestAlgo: DigestAlgorithm

    The digest algorithm (defaults to SHA-1, matching C#).

  Returns Promise<void>