<?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 => 'es',
  ),
  'this' => 
  array (
    0 => 'function.iconv-mime-encode.php',
    1 => 'iconv_mime_encode',
    2 => 'Construye un encabezado MIME con los campos field_name y field_value',
  ),
  'up' => 
  array (
    0 => 'ref.iconv.php',
    1 => 'Funciones de 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' => 'es',
    '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">Construye un encabezado MIME con los campos field_name y field_value</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.iconv-mime-encode-description">
  <h3 class="title">Descripción</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">
   <span class="function"><strong>iconv_mime_encode()</strong></span> compone y devuelve una
   cadena de caracteres que representa un campo
   encabezado <code class="literal">MIME</code> similar a:
   <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>
   En el ejemplo anterior, <code class="literal">&quot;Subject&quot;</code> es el nombre
   del campo y la parte que comienza por
   <code class="literal">&quot;=?ISO-8859-1?...&quot;</code> es el valor del 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">
       El nombre del campo.
      </p>
     </dd>
    
    
     <dt><code class="parameter">field_value</code></dt>
     <dd>
      <p class="para">
       El valor del campo.
      </p>
     </dd>
    
    
     <dt><code class="parameter">options</code></dt>
     <dd>
      <p class="para">
       Puede controlarse el comportamiento de la función
       <span class="function"><strong>iconv_mime_encode()</strong></span> especificando
       un array asociativo que contenga la configuración de
       los elementos en el parámetro <code class="parameter">options</code>.
       La lista de elementos soportados por
       <span class="function"><strong>iconv_mime_encode()</strong></span> se muestra a continuación.
       Tenga en cuenta que los nombres de los elementos son sensibles a mayúsculas/minúsculas.
       <table class="doctable table">
        <caption><strong>Lista de elementos soportados por <span class="function"><strong>iconv_mime_encode()</strong></span></strong></caption>
        
         <thead>
          <tr>
           <th>Elemento</th>
           <th>Tipo</th>
           <th>Descripción</th>
           <th>Valor por omisión</th>
           <th>Ejemplo</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 el método de codificación de un campo. Los valores posibles son <code class="literal">&quot;B&quot;</code> o <code class="literal">&quot;Q&quot;</code>, donde
            <code class="literal">&quot;B&quot;</code> indica que el esquema de codificación será <code class="literal">base64</code> y <code class="literal">&quot;Q&quot;</code>,
            <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 el juego de caracteres para representar el primer parámetro
            <code class="parameter">field_name</code> y el segundo parámetro
            <code class="parameter">field_value</code>. Si se omite,
            <span class="function"><strong>iconv_mime_encode()</strong></span>
            utilizará la directiva de configuración
            <a href="iconv.configuration.php" class="link">iconv.internal_encoding</a>
            de su php.ini para representarlos.
           </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 el juego de caracteres a utilizar para componer
            el encabezado <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 la longitud máxima de cada encabezado.
            Si el encabezado es mayor que la longitud definida por este parámetro,
            el encabezado resultante será un encabezado compuesto por varias líneas
            conforme al estándar <a href="https://datatracker.ietf.org/doc/html/rfc2822" class="link external">&raquo;&nbsp;RFC2822 - Internet Message Format</a>.
            Si se omite, la longitud máxima se establecerá en 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 los caracteres de fin de línea. Si se omite, el valor por omisión será <code class="literal">&quot;\r\n&quot;</code>
            (<code class="literal">CR</code> <code class="literal">LF</code>). Tenga en cuenta que este parámetro siempre
            se representa como una cadena ASCII en relación con el valor del parámetro
          <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">Valores devueltos</h3>
  <p class="para">
   Devuelve un campo <code class="literal">MIME</code> en caso de éxito,
   o <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si ocurre un error durante la codificación.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.iconv-mime-encode-examples">
  <h3 class="title">Ejemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Ejemplo #1 Ejemplo con <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">// Esto produce "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">// Esto produce "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">Ver también</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> - Convierte una string de 8 bits en una string en base64</span></li>
    <li><span class="function"><a href="function.mb-encode-mimeheader.php" class="function" rel="rdfs-seeAlso">mb_encode_mimeheader()</a> - Codifica una cadena para un encabezado MIME</span></li>
    <li><span class="function"><a href="function.imap-8bit.php" class="function" rel="rdfs-seeAlso">imap_8bit()</a> - Convierte un string de 8 bits en un string codificado en Quoted-Printable</span></li>
    <li><span class="function"><a href="function.quoted-printable-encode.php" class="function" rel="rdfs-seeAlso">quoted_printable_encode()</a> - Convierte un string de 8 bits en un string quoted-printable</span></li>
   </ul>
  </p>
 </div>


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