<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.iconv-mime-decode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>iconv_mime_decode</refname>
  <refpurpose>Decodes a <literal>MIME</literal> header field</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>iconv_mime_decode</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Decodes a <literal>MIME</literal> header field.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       The encoded header, as a string.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       <parameter>mode</parameter> determines the behaviour in the event
       <function>iconv_mime_decode</function> encounters a malformed
       <literal>MIME</literal> header field. You can specify any combination
       of the following bitmasks.
       <table>
        <title>Bitmasks acceptable to <function>iconv_mime_decode</function></title>
        <tgroup cols="3">
         <thead>
          <row>
           <entry>Value</entry>
           <entry>Constant</entry>
           <entry>Description</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>1</entry>
           <entry>ICONV_MIME_DECODE_STRICT</entry>
           <entry>
            If set, the given header is decoded in full conformance with the
            standards defined in <link xlink:href="&url.rfc;2047">RFC2047</link>.
            This option is disabled by default because there are a lot of
            broken mail user agents that don't follow the specification and don't
            produce correct <literal>MIME</literal> headers.
           </entry>
          </row>
          <row>
           <entry>2</entry>
           <entry>ICONV_MIME_DECODE_CONTINUE_ON_ERROR</entry>
           <entry>
            If set, <function>iconv_mime_decode_headers</function>
            attempts to ignore any grammatical errors and continue to process
            a given header.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      <para>
       The optional <parameter>encoding</parameter> parameter specifies the
       character set to represent the result by. If omitted or &null;,
       <link linkend="iconv.configuration">iconv.internal_encoding</link>
       will be used.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a decoded <literal>MIME</literal> field on success,
   or &false; if an error occurs during the decoding.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>encoding</parameter> is nullable now.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>iconv_mime_decode</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
// This yields "Subject: Prüfung Prüfung"
echo iconv_mime_decode("Subject: =?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?=",
                       0, "ISO-8859-1");
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>iconv_mime_decode_headers</function></member>
    <member><function>mb_decode_mimeheader</function></member>
    <member><function>imap_mime_header_decode</function></member>
    <member><function>imap_base64</function></member>
    <member><function>imap_qprint</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:"~/.phpdoc/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
-->
