<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.iconv-mime-encode.php',
    1 => 'iconv_mime_encode',
    2 => 'Comp&otilde;e um campo de cabe&ccedil;alho MIME',
  ),
  'up' => 
  array (
    0 => 'ref.iconv.php',
    1 => 'iconv Fun&ccedil;&otilde;es',
  ),
  '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' => 'pt_BR',
    '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">Compõe um campo de cabeçalho <code class="literal">MIME</code></span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.iconv-mime-encode-description">
  <h3 class="title">Descrição</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">
   Compõe e retorna uma string que representa um campo de cabeçalho <code class="literal">MIME</code> válido,
   semelhante ao seguinte:
   <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>
   No exemplo acima, &quot;Subject&quot; é o nome do campo e a parte que
   começa com &quot;=?ISO-8859-1?...&quot; é o valor do campo.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.iconv-mime-encode-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">field_name</code></dt>
     <dd>
      <p class="para">
       O nome do campo.
      </p>
     </dd>
    
    
     <dt><code class="parameter">field_value</code></dt>
     <dd>
      <p class="para">
       O valor do campo.
      </p>
     </dd>
    
    
     <dt><code class="parameter">options</code></dt>
     <dd>
      <p class="para">
       Você pode controlar o comportamento de <span class="function"><strong>iconv_mime_encode()</strong></span>
       especificando um array associativo que contém itens de configuração
       para as <code class="parameter">options</code> opcionais do terceiro parâmetro.
       Os itens suportados por <span class="function"><strong>iconv_mime_encode()</strong></span> estão
       listados abaixo. Observe que os nomes dos itens são tratados com distinção entre maiúsculas e minúsculas.
       <table class="doctable table">
        <caption><strong>Itens de configuração suportados por <span class="function"><strong>iconv_mime_encode()</strong></span></strong></caption>
        
         <thead>
          <tr>
           <th>Item</th>
           <th>Tipo</th>
           <th>Descrição</th>
           <th>Valor padrão</th>
           <th>Exemplo</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>
            Especifica o método para codificar um valor de campo. O valor
            deste item pode ser &quot;B&quot; ou &quot;Q&quot;, onde &quot;B&quot; significa
            esquema de codificação <code class="literal">base64</code> e &quot;Q&quot; significa esquema
            de codificação <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>
            Especifica o conjunto de caracteres no qual o primeiro parâmetro
            <code class="parameter">field_name</code>  e o segundo parâmetro
            <code class="parameter">field_value</code> são apresentados. Se não for fornecido,
            <span class="function"><strong>iconv_mime_encode()</strong></span> assume que esses parâmetros
            são apresentados a ele na configuração 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>
            Especifica o conjunto de caracteres a ser usado para compor o
            cabeçalho <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>
            Especifica o comprimento máximo das linhas de cabeçalho. O cabeçalho
            resultante é &quot;dobrado&quot; em um conjunto de múltiplas linhas caso o
            campo do cabeçalho resultante seja maior que o valor deste
            parâmetro, de acordo com
            <a href="https://datatracker.ietf.org/doc/html/rfc2822" class="link external">&raquo;&nbsp;RFC2822 - Internet Message Format</a>.
            Se não for fornecido, o comprimento será limitado a 76 caracteres.
           </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>
            Especifica a sequência de caracteres a ser anexada a cada linha
            como um sinal de fim de linha quando a &quot;dobragem&quot; é executada em um campo de
            cabeçalho longo. Se não fornecido, o padrão é &quot;\r\n&quot;
            (<code class="literal">CR</code> <code class="literal">LF</code>). Observe que
            esse parâmetro é sempre tratado como uma string ASCII,
            independentemente do valor de <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">Valor Retornado</h3>
  <p class="para">
   Retorna um campo <code class="literal">MIME</code> codificado em caso de sucesso
   ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> se ocorrer um erro durante a codificação.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.iconv-mime-encode-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemplo #1 Exemplo <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">// Isto resulta em "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">// Isto resulta em "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">Veja Também</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> - Converte uma string de 8 bits em uma string base64</span></li>
    <li><span class="function"><a href="function.mb-encode-mimeheader.php" class="function" rel="rdfs-seeAlso">mb_encode_mimeheader()</a> - Codificar string para cabe&ccedil;alho MIME</span></li>
    <li><span class="function"><a href="function.imap-8bit.php" class="function" rel="rdfs-seeAlso">imap_8bit()</a> - Converte uma string de 8 bits em uma string imprim&iacute;vel escapada</span></li>
    <li><span class="function"><a href="function.quoted-printable-encode.php" class="function" rel="rdfs-seeAlso">quoted_printable_encode()</a> - Converte uma string de 8 bits para uma string Quoted-Printable</span></li>
   </ul>
  </p>
 </div>


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