doc-fr/reference/mbstring/functions/mb-encode-mimeheader.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.17 $ -->
<!-- EN-Revision: 1.14 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<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>Encode une chaîne pour un en-tête MIM</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mb_encode_mimeheader</methodname>
   <methodparam><type>string</type><parameter>str</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>transfer_encoding</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>linefeed</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>indent</parameter></methodparam>
  </methodsynopsis>
  <para>
   Encode la chaîne <parameter>str</parameter> en un en-tête MIME.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>str</parameter></term>
     <listitem>
      <para>
       La chaîne à encoder.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>charset</parameter></term>
     <listitem>
      <para>
       <parameter>charset</parameter> est le nom de l'encodage utilisé
       par la chaîne <parameter>str</parameter>. La valeur par défaut
       est déterminée par les paramètres courants du NLS
       (<literal>mbstring.language</literal>).
       <function>mb_internal_encoding</function> doit être le même encodage.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>transfer_encoding</parameter></term>
     <listitem>
      <para>
       <parameter>transfer_encoding</parameter> est l'encodage de transfert. Il
       peut être <literal>"B"</literal> (Base64) ou
       <literal>"Q"</literal> (Quoted-Printable). Par défaut, c'est
       <literal>"B"</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>linefeed</parameter></term>
     <listitem>
      <para>
       <parameter>linefeed</parameter> spécifie les fins de lignes (EOF :
       end-of-line) utilisé par <function>mb_encode_mimeheader</function>
       pour formater la chaîne (une <link xlink:href="&url.rfc;2822">RFC</link>
       définie la longueur d'une chaîne à partir de laquelle on doit ajouter
       une fin de ligne. La longueur courante est 74 caractères). La valeur
       par défaut est <literal>"\r\n"</literal> (CRLF).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>indent</parameter></term>
     <listitem>
      <para>
       Indentation de la première ligne (nombre de caractères dans l'en-tête
       avant la chaîne <parameter>str</parameter>).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Une version convertie de la chaîne en ASCII.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.0.0</entry>
       <entry>
        Le paramètre <parameter>indent</parameter> a été ajouté.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>mb_encode_mimeheader</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$name = ""; // kanji
$mbox = "kru";
$doma = "gtinn.mon";
$addr = mb_encode_mimeheader($name, "UTF-7", "Q") . " <" . $mbox . "@" . $doma . ">";
echo $addr;
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Cette fonction n'est pas faite pour couper les lignes en milieu de mots.
    Ce comportement peut ajouter des espaces non désirées dans un mot de la
    chaîne originale.
   </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:"../../../../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
-->