archived-doc-ru/reference/mbstring/functions/mb-encode-mimeheader.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 936691e7449fe193b474f7d29df152952e9b8df6 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>
   Кодирует по схеме кодирования MIME-заголовка переданную
   в параметр <parameter>string</parameter> строку (<type>string</type>).
  </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 (<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 — термин <link xlink:href="&url.rfc;2822">RFC</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.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>Пример использования функции <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-?=" <kru@gtinn.mon>
]]>
    </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
-->