imap-mime-header-decode.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e2f50c240bebc502a3d990d73633a6141f3bd9fd Maintainer: nobody Status: ready -->
<refentry xml:id="function.imap-mime-header-decode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>imap_mime_header_decode</refname>
  <refpurpose>Dekodiert MIME-kodierte Kopfzeilen</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>imap_mime_header_decode</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
  </methodsynopsis>
  <para>
   Dekodiert MIME-kodierte Kopfzeilen, die nicht-ASCII-Zeichen enthalten
   (siehe <link xlink:href="&url.rfc;2047">RFC2047</link>).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Der MIME-kodierte Text
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Die dekodierten Textteile werden als ein Array von Objekten zurückgegeben,
   die jeweils eine <literal>charset</literal>- und eine
   <literal>text</literal>-Eigenschaft enthalten.
  </para>
  <para>
   Für nicht kodierte ASCII-Teile wird die
   <literal>charset</literal>-Eigenschaft auf den Wert
   <literal>default</literal> gesetzt.
  </para>
  <para>
   Die Funktion gibt bei einem Fehler &false; zurück.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>imap_mime_header_decode</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
$text = "=?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?= <keld@example.com>";

$elements = imap_mime_header_decode($text);
for ($i=0; $i<count($elements); $i++) {
    echo "Zeichensatz: {$elements[$i]->charset}\n";
    echo "Text: {$elements[$i]->text}\n\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Zeichensatz: ISO-8859-1
Text: Keld Jørn Simonsen

Zeichensatz: default
Text:  <keld@example.com>
]]>
    </screen>
   </example>
  </para>
  <para>
   In diesem Beispiel erhalten wir zwei Textteile zurück, den ersten kodiert
   im westeuropäischen ISO-8859-1-Zeichensatz und den zweiten als einfachen
   ASCII-String.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imap_utf8</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
-->