<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: 398329d3c680e8eccd694a6a3f7fe1ebd929ea80 Maintainer: tmn Status: ready -->

<!-- Reviewed: no -->

<refentry xml:id="function.mb-encode-mimeheader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<refnamediv>

<refname>mb_encode_mimeheader</refname>

<refpurpose>Кодирует строку для заголовка MIME</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>string</type><methodname>mb_encode_mimeheader</methodname>

<methodparam><type>string</type><parameter>string</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>charset</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>transfer_encoding</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type>string</type><parameter>newline</parameter><initializer>"\r\n"</initializer></methodparam>

<methodparam choice="opt"><type>int</type><parameter>indent</parameter><initializer>0</initializer></methodparam>

</methodsynopsis>

<para>

Функция кодирует строку (<type>string</type>), которую передали

в аргументе <parameter>string</parameter>, по схеме кодирования MIME-заголовка.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>string</parameter></term>

<listitem>

<para>

Строка (<type>string</type>), которую требуется закодировать.

Параметр принимает строку, кодировка которой совпадает с кодировкой,

которую возвращает функция <function>mb_internal_encoding</function>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>charset</parameter></term>

<listitem>

<para>

Параметр <parameter>charset</parameter> определяет название набора символов,

в котором представляется строка <parameter>string</parameter>.

Значение по умолчанию определяется настройкой национального языка по умолчанию

(англ. NLS, National Language Setting), которую устанавливает директива <literal>mbstring.language</literal>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>transfer_encoding</parameter></term>

<listitem>

<para>

Параметр <parameter>transfer_encoding</parameter> определяет схему MIME-кодирования.

Параметр принимает либо значение <literal>«B»</literal>, которое указывает кодировку Base64,

либо значение <literal>«Q»</literal>, которое указывает кодировку Quoted-Printable.

Значение по умолчанию равно <literal>«B»</literal>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>newline</parameter></term>

<listitem>

<para>

Параметр <parameter>newline</parameter> определяет EOL-метку конца строки (англ. end-of-line),

которой функция <function>mb_encode_mimeheader</function>

переносит строки (англ. line-folding). Line-folding — термин стандарта <link xlink:href="&url.rfc;2822">RFC 2822</link>,

который означает разбиение строки, длина которой превышает конкретную величину, на несколько строк.

Длину разбиения строки жёстко закодировали и установили значение в 74 символа.

Значение по умолчанию определили последовательностью символов <literal>«\r\n»</literal>, или CRLF.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>indent</parameter></term>

<listitem>

<para>

Отступ первой строки — количество символов в заголовке перед параметром <parameter>string</parameter>.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Функция возвращает версию строки (<type>string</type>),

которую преобразовала в ASCII-представление.

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.3.0</entry>

<entry>

<literal>NUL</literal>-байты больше не отбрасываются при кодировании

строк по правилам синтаксиса QP-кодировки (англ. Quoted-Printable),

а кодируются как <literal>=00</literal>. Нулевой байт — байт со значением 0,

который в наборах символов назначают нулевой кодовой точке.

</entry>

</row>

<row>

<entry>8.0.0</entry>

<entry>

Параметры <parameter>charset</parameter> и <parameter>transfer_encoding</parameter>

теперь принимают значение &null;.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Пример кодировки строки для заголовка MIME функцией <function>mb_encode_mimeheader</function></title>

<programlisting role="php">

<![CDATA[

<?php

$name = "太郎"; // kanji

$mbox = "kru";

$doma = "gtinn.mon";

$addr = '"' . addcslashes(mb_encode_mimeheader($name, "UTF-7", "Q"), '"') . '" <' . $mbox . "@" . $doma . ">";

echo $addr;

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

"=?UTF-7?Q?+WSqQzg-?=" <[email protected]>

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<note>

<para>

Функция не переносит строки в высокоуровневых точках разрыва строк на основе контекста

наподобие границ слов и аналогичных. Такое поведение иногда загромождает исходную строку

неожиданными пробелами.

</para>

</note>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>mb_decode_mimeheader</function></member>

</simplelist>

</para>

</refsect1>

</refentry>

<!-- Keep this comment at the end of the file

Local variables:

mode: sgml

sgml-omittag:t

sgml-shorttag:t

sgml-minimize-attributes:nil

sgml-always-quote-attributes:t

sgml-indent-step:1

sgml-indent-data:t

indent-tabs-mode:nil

sgml-parent-document:nil

sgml-default-dtd-file:"~/.phpdoc/manual.ced"

sgml-exposed-tags:nil

sgml-local-catalogs:nil

sgml-local-ecat-files:nil

End:

vim600: syn=xml fen fdm=syntax fdl=2 si

vim: et tw=78 syn=sgml

vi: ts=1 sw=1

-->