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

    Class FormatOptions

    Format options for serializing MimeKit objects.

    Represents the available options for formatting MIME messages and entities when writing them.

    Index
    default: FormatOptions = ...

    The default formatting options.

    If custom options are not supplied to formatting methods, these options are used. The default instance is frozen in this port.

    maxLineLength: number = DEFAULT_MAX_LINE_LENGTH

    Maximum line length used by encoders when line-wrapping headers.

    newLineFormat: NewLineFormat = ...

    New-line sequence used when writing. Mirrors C#'s Environment.NewLine: LF on Unix/macOS, CRLF on Windows (via platformNewLineFormat); browsers and other OS-less runtimes default to CRLF (wire-canonical). On the Unix hosts this port is verified against, this resolves to LF — matching the byte-parity oracle. Callers who need deterministic output should set this explicitly.

    ensureNewLine: boolean = false

    Whether formatted messages should always end with a new-line sequence.

    verifyingSignature: boolean = false

    Whether a signature is currently being verified.

    C#: FormatOptions.VerifyingSignature (internal). When set, a MimePart whose content has mixed line endings is written verbatim rather than canonicalized, so the bytes fed to the signature verifier match the exact bytes that were signed (see MimeKit issue #569).

    international: boolean = false

    Whether internationalized email formatting rules should be used.

    This corresponds to the RFC 6530/RFC 6532 formatting mode and is intended for SMTPUTF8 or UTF8 APPEND scenarios.

    allowMixedHeaderCharsets: boolean = false

    Whether encoded headers may use us-ascii or iso-8859-1 when that improves readability instead of forcing every encoded-word to use one charset.

    parameterEncodingMethod: ParameterEncodingMethod = 'rfc2231'

    Parameter value encoding method used when a parameter requests the default encoding method.

    alwaysQuoteParameterValues: boolean = false

    Whether Content-Type and Content-Disposition parameter values should always be quoted, even when quoting is not required by MIME syntax.

    hiddenHeaders: Set<HeaderId> = ...

    C#: FormatOptions.HiddenHeaders. Header ids that are suppressed when a message is serialized (used by MessagePartial.Split to strip everything but the content headers). Empty by default.