<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.iconv.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.iconv-mime-encode.php',
    1 => 'iconv_mime_encode',
    2 => 'Создаёт поле MIME-заголовка',
  ),
  'up' => 
  array (
    0 => 'ref.iconv.php',
    1 => 'Функции iconv',
  ),
  'prev' => 
  array (
    0 => 'function.iconv-mime-decode-headers.php',
    1 => 'iconv_mime_decode_headers',
  ),
  'next' => 
  array (
    0 => 'function.iconv-set-encoding.php',
    1 => 'iconv_set_encoding',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/iconv/functions/iconv-mime-encode.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.iconv-mime-encode" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">iconv_mime_encode</h1>
  <p class="verinfo">(PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">iconv_mime_encode</span> &mdash; <span class="dc-title">Создаёт поле <code class="literal">MIME</code>-заголовка</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.iconv-mime-encode-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>iconv_mime_encode</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$field_name</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$field_value</code></span>, <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$options</code><span class="initializer"> = []</span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   Создаёт и возвращает корректное поле <code class="literal">MIME</code>-заголовка в виде строки вида:
   <div class="example-contents screen">
<div class="descriptioncode"><pre class="descriptioncode">Subject: =?ISO-8859-1?Q?Pr=FCfung_f=FCr?= Entwerfen von einer MIME kopfzeile</pre>
</div>
   </div>
   В примере выше &quot;Subject&quot; является именем поля, а часть строки, начиная с
   &quot;=?ISO-8859-1?...&quot; - его значение.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.iconv-mime-encode-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">field_name</code></dt>
     <dd>
      <p class="para">
       Имя поля.
      </p>
     </dd>
    
    
     <dt><code class="parameter">field_value</code></dt>
     <dd>
      <p class="para">
       Значение поля.
      </p>
     </dd>
    
    
     <dt><code class="parameter">options</code></dt>
     <dd>
      <p class="para">
       Есть возможность контролировать поведение функции
       <span class="function"><strong>iconv_mime_encode()</strong></span> посредством передачи массива с
       настройками в качестве третьего аргумента
       <code class="parameter">options</code>. Возможные значения этого массива,
       поддерживаемые функцией <span class="function"><strong>iconv_mime_encode()</strong></span>,
       перечислены ниже. Обратите внимание, что имена элементов чувствительны
       к регистру символов.
       <table class="doctable table">
        <caption><strong>
         Настройки, поддерживаемые в <span class="function"><strong>iconv_mime_encode()</strong></span>
        </strong></caption>
        
         <thead>
          <tr>
           <th>Элемент</th>
           <th>Тип</th>
           <th>Описание</th>
           <th>Значение по умолчанию</th>
           <th>Пример</th>
          </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td>scheme</td>
           <td><span class="type"><a href="language.types.string.php" class="type string">string</a></span></td>
           <td>
            Задаёт, каким образом закодировать значение поля. Значением этого
            элемента может быть либо &quot;B&quot;, либо &quot;Q&quot;. &quot;B&quot; означает схему кодирования
            <code class="literal">base64</code>, а &quot;Q&quot; - <code class="literal">quoted-printable</code>.
           </td>
           <td>B</td>
           <td>B</td>
          </tr>

          <tr>
           <td>input-charset</td>
           <td><span class="type"><a href="language.types.string.php" class="type string">string</a></span></td>
           <td>
            Задаёт, в какой кодировке представлены аргументы
            <code class="parameter">field_name</code> и
            <code class="parameter">field_value</code>. Если не задан,
            <span class="function"><strong>iconv_mime_encode()</strong></span> предполагает, что набор символов
            указан в ini-настройке <a href="iconv.configuration.php" class="link">iconv.internal_encoding</a>.
           </td>
           <td>
            <a href="iconv.configuration.php" class="link">iconv.internal_encoding</a>
           </td>
           <td>ISO-8859-1</td>
          </tr>

          <tr>
           <td>output-charset</td>
           <td><span class="type"><a href="language.types.string.php" class="type string">string</a></span></td>
           <td>
            Задаёт набор символов, в котором будет представлен результирующий
            <code class="literal">MIME</code>-заголовок.
           </td>
           <td>
            <a href="iconv.configuration.php" class="link">iconv.internal_encoding</a>
           </td>
           <td>UTF-8</td>
          </tr>

          <tr>
           <td>line-length</td>
           <td><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></td>
           <td>
            Устанавливает максимальную длину строк заголовка. Если результирующий
            заголовок окажется длиннее этой величины, функция его разрежет на
            несколько строк в соответствии с <a href="https://datatracker.ietf.org/doc/html/rfc2822" class="link external">&raquo;&nbsp;Форматом интернет сообщений - RFC2822</a>.
            Если не задан, эта длина будет установлена 76 символов.
           </td>
           <td>76</td>
           <td>996</td>
          </tr>

          <tr>
           <td>line-break-chars</td>
           <td><span class="type"><a href="language.types.string.php" class="type string">string</a></span></td>
           <td>
            Задаёт последовательность символов, которые будут использоваться
            для завершения &quot;разрезанных&quot; строк заголовка, если заголовок окажется
            длиннее одной строки. Если не задан, будут использоваться символы
            &quot;\r\n&quot; (<code class="literal">CR</code> <code class="literal">LF</code>). Обратите
            внимание, что этот аргумент всегда обрабатывается как строка ASCII
            вне зависимости от значения <code class="literal">input-charset</code>.
           </td>
           <td>\r\n</td>
           <td>\n</td>
          </tr>

         </tbody>
        
       </table>

      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.iconv-mime-encode-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Возвращает закодированное <code class="literal">MIME</code>-поле в случае успешного выполнения
   или <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> в случае возникновения ошибки.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.iconv-mime-encode-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Пример использования <span class="function"><strong>iconv_mime_encode()</strong></span></strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$preferences </span><span style="color: #007700">= array(<br />    </span><span style="color: #DD0000">"input-charset" </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">"ISO-8859-1"</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">"output-charset" </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">"UTF-8"</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">"line-length" </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">76</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">"line-break-chars" </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">"\n"<br /></span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$preferences</span><span style="color: #007700">[</span><span style="color: #DD0000">"scheme"</span><span style="color: #007700">] = </span><span style="color: #DD0000">"Q"</span><span style="color: #007700">;<br /></span><span style="color: #FF8000">// Результат "Subject: =?UTF-8?Q?Pr=C3=BCfung=20Pr=C3=BCfung?="<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">iconv_mime_encode</span><span style="color: #007700">(</span><span style="color: #DD0000">"Subject"</span><span style="color: #007700">, </span><span style="color: #DD0000">"Prüfung Prüfung"</span><span style="color: #007700">, </span><span style="color: #0000BB">$preferences</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$preferences</span><span style="color: #007700">[</span><span style="color: #DD0000">"scheme"</span><span style="color: #007700">] = </span><span style="color: #DD0000">"B"</span><span style="color: #007700">;<br /></span><span style="color: #FF8000">// Результат "Subject: =?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?="<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">iconv_mime_encode</span><span style="color: #007700">(</span><span style="color: #DD0000">"Subject"</span><span style="color: #007700">, </span><span style="color: #DD0000">"Prüfung Prüfung"</span><span style="color: #007700">, </span><span style="color: #0000BB">$preferences</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.iconv-mime-encode-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.imap-binary.php" class="function" rel="rdfs-seeAlso">imap_binary()</a> - Конвертирует 8-битную строку в строку base64</span></li>
    <li><span class="function"><a href="function.mb-encode-mimeheader.php" class="function" rel="rdfs-seeAlso">mb_encode_mimeheader()</a> - Кодирует строку для заголовка MIME</span></li>
    <li><span class="function"><a href="function.imap-8bit.php" class="function" rel="rdfs-seeAlso">imap_8bit()</a> - Конвертирует 8-битную строку в строку в формате quoted-printable</span></li>
    <li><span class="function"><a href="function.quoted-printable-encode.php" class="function" rel="rdfs-seeAlso">quoted_printable_encode()</a> - Преобразовывает 8-битную строку методом quoted-printable</span></li>
   </ul>
  </p>
 </div>


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