<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mbstring.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.mb-encode-mimeheader.php',
    1 => 'mb_encode_mimeheader',
    2 => 'Кодирует строку для заголовка MIME',
  ),
  'up' => 
  array (
    0 => 'ref.mbstring.php',
    1 => 'Функции для работы с многобайтовыми строками',
  ),
  'prev' => 
  array (
    0 => 'function.mb-detect-order.php',
    1 => 'mb_detect_order',
  ),
  'next' => 
  array (
    0 => 'function.mb-encode-numericentity.php',
    1 => 'mb_encode_numericentity',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/mbstring/functions/mb-encode-mimeheader.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.mb-encode-mimeheader" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">mb_encode_mimeheader</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.6, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">mb_encode_mimeheader</span> &mdash; <span class="dc-title">Кодирует строку для заголовка MIME</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.mb-encode-mimeheader-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>mb_encode_mimeheader</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$string</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$charset</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$transfer_encoding</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$newline</code><span class="initializer"> = &quot;\r\n&quot;</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$indent</code><span class="initializer"> = 0</span></span><br>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="para rdfs-comment">
   Функция кодирует строку (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>), которую передали
   в аргументе <code class="parameter">string</code>, по схеме кодирования MIME-заголовка.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.mb-encode-mimeheader-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">string</code></dt>
     <dd>
      <p class="para">
       Строка (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>), которую требуется закодировать.
       Параметр принимает строку, кодировка которой совпадает с кодировкой,
       которую возвращает функция <span class="function"><a href="function.mb-internal-encoding.php" class="function">mb_internal_encoding()</a></span>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">charset</code></dt>
     <dd>
      <p class="para">
       Параметр <code class="parameter">charset</code> определяет название набора символов,
       в котором представляется строка <code class="parameter">string</code>.
       Значение по умолчанию определяется настройкой национального языка по умолчанию
       (англ. NLS, National Language Setting), которую устанавливает директива <code class="literal">mbstring.language</code>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">transfer_encoding</code></dt>
     <dd>
      <p class="para">
       Параметр <code class="parameter">transfer_encoding</code> определяет схему MIME-кодирования.
       Параметр принимает либо значение <code class="literal">«B»</code>, которое указывает кодировку Base64,
       либо значение <code class="literal">«Q»</code>, которое указывает кодировку Quoted-Printable.
       Значение по умолчанию равно <code class="literal">«B»</code>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">newline</code></dt>
     <dd>
      <p class="para">
       Параметр <code class="parameter">newline</code> определяет EOL-метку конца строки (англ. end-of-line),
       которой функция <span class="function"><strong>mb_encode_mimeheader()</strong></span>
       переносит строки (англ. line-folding). Line-folding — термин стандарта <a href="https://datatracker.ietf.org/doc/html/rfc2822" class="link external">&raquo;&nbsp;RFC 2822</a>,
       который означает разбиение строки, длина которой превышает конкретную величину, на несколько строк.
       Длину разбиения строки жёстко закодировали и установили значение в 74 символа.
       Значение по умолчанию определили последовательностью символов <code class="literal">«\r\n»</code>, или CRLF.
      </p>
     </dd>
    
    
     <dt><code class="parameter">indent</code></dt>
     <dd>
      <p class="para">
       Отступ первой строки — количество символов в заголовке перед параметром <code class="parameter">string</code>.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.mb-encode-mimeheader-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Функция возвращает версию строки (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>),
   которую преобразовала в ASCII-представление.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.mb-encode-mimeheader-changelog">
  <h3 class="title">Список изменений</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Версия</th>
      <th>Описание</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.3.0</td>
      <td>
       <code class="literal">NUL</code>-байты больше не отбрасываются при кодировании
       строк по правилам синтаксиса QP-кодировки (англ. Quoted-Printable),
       а кодируются как <code class="literal">=00</code>. Нулевой байт — байт со значением 0,
       который в наборах символов назначают нулевой кодовой точке.
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       Параметры <code class="parameter">charset</code> и <code class="parameter">transfer_encoding</code>
       теперь принимают значение <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.mb-encode-mimeheader-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Пример кодировки строки для заголовка MIME функцией <span class="function"><strong>mb_encode_mimeheader()</strong></span></strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$name </span><span style="color: #007700">= </span><span style="color: #DD0000">"太郎"</span><span style="color: #007700">; </span><span style="color: #FF8000">// kanji<br /></span><span style="color: #0000BB">$mbox </span><span style="color: #007700">= </span><span style="color: #DD0000">"kru"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$doma </span><span style="color: #007700">= </span><span style="color: #DD0000">"gtinn.mon"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$addr </span><span style="color: #007700">= </span><span style="color: #DD0000">'"' </span><span style="color: #007700">. </span><span style="color: #0000BB">addcslashes</span><span style="color: #007700">(</span><span style="color: #0000BB">mb_encode_mimeheader</span><span style="color: #007700">(</span><span style="color: #0000BB">$name</span><span style="color: #007700">, </span><span style="color: #DD0000">"UTF-7"</span><span style="color: #007700">, </span><span style="color: #DD0000">"Q"</span><span style="color: #007700">), </span><span style="color: #DD0000">'"'</span><span style="color: #007700">) . </span><span style="color: #DD0000">'" &lt;' </span><span style="color: #007700">. </span><span style="color: #0000BB">$mbox </span><span style="color: #007700">. </span><span style="color: #DD0000">"@" </span><span style="color: #007700">. </span><span style="color: #0000BB">$doma </span><span style="color: #007700">. </span><span style="color: #DD0000">"&gt;"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">$addr</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    
<div class="example-contents"><p>
 Результат выполнения приведённого примера:
</p></div>

    <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">&quot;=?UTF-7?Q?+WSqQzg-?=&quot; &lt;kru@gtinn.mon&gt;</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.mb-encode-mimeheader-notes">
  <h3 class="title">Примечания</h3>
  <blockquote class="note"><p><strong class="note">Замечание</strong>: 
   <p class="para">
    Функция не переносит строки в высокоуровневых точках разрыва строк на основе контекста
    наподобие границ слов и аналогичных. Такое поведение иногда загромождает исходную строку
    неожиданными пробелами.
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.mb-encode-mimeheader-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.mb-decode-mimeheader.php" class="function" rel="rdfs-seeAlso">mb_decode_mimeheader()</a> - Декодирует строку в MIME-заголовке</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>