mb_encode_mimeheader

Encode string for MIME header.

mb_encode_mimeheader Function synopsis

mb_encode_mimeheader(
    string $string,
    ?string $charset = null,
    ?string $transfer_encoding = null,
    string $newline = "\r\n",
    int $indent = 0
  ): string

Parameters

$string

Typestring

The string being encoded. Its encoding should be same as mb_internal_encoding.

$charset

OptionalType?stringDefault valuenull

$charset specifies the name of the character set in which $string is represented in. The default value is determined by the current NLS setting (mbstring.language).

$transfer_encoding

OptionalType?stringDefault valuenull

$transfer_encoding specifies the scheme of MIME encoding. It should be either "B" (Base64) or "Q" (Quoted-Printable). Falls back to "B" if not given.

$newline

OptionalTypestringDefault value"\r\n"

$newline specifies the EOL (end-of-line) marker with which mb_encode_mimeheader performs line-folding (a RFC term, the act of breaking a line longer than a certain length into multiple lines. The length is currently hard-coded to 74 characters). Falls back to "\r\n" (CRLF) if not given.

$indent

OptionalTypeintDefault value0

Indentation of the first line (number of characters in the header before $string).

Return value

Typestring

A converted version of the string represented in ASCII.