Function encodePhrase

encodePhrase(
    options: FormatOptions,
    charset: string | CharsetEncoding,
    phrase: string,
    startIndex: number,
    count: number,
): Uint8Array
Encode a phrase according to RFC 2047 using supplied formatting options.
Parameters
- options: FormatOptions
  Formatting options.
- charset: string | CharsetEncoding
  Charset encoding or name.
- phrase: string
  Phrase to encode.
- startIndex: number
  Starting character index.
- count: number
  Number of characters to encode.
Returns Uint8Array
The encoded phrase bytes.

Throws
options, charset, or phrase is invalid.

Throws
startIndex or count is outside phrase.
- Defined in src/utils/rfc2047.ts:1426
encodePhrase(
    options: FormatOptions,
    charset: string | CharsetEncoding,
    phrase: string,
): Uint8Array
Encode a phrase according to RFC 2047 using supplied formatting options.
Parameters
- options: FormatOptions
  Formatting options.
- charset: string | CharsetEncoding
  Charset encoding or name.
- phrase: string
  Phrase to encode.
Returns Uint8Array
The encoded phrase bytes.
- Defined in src/utils/rfc2047.ts:1435
encodePhrase(
    charset: string | CharsetEncoding,
    phrase: string,
    startIndex?: number,
    count?: number,
): Uint8Array
Encode a phrase according to RFC 2047 using default formatting options.
Parameters
- charset: string | CharsetEncoding
  Charset encoding or name.
- phrase: string
  Phrase to encode.
- OptionalstartIndex: number
  Starting character index.
- Optionalcount: number
  Number of characters to encode.
Returns Uint8Array
The encoded phrase bytes.
- Defined in src/utils/rfc2047.ts:1445

Function encodePhrase

Parameters

Returns Uint8Array

Throws

Throws

Parameters

Returns Uint8Array

Parameters

Returns Uint8Array

Settings