File: imap.xml

package info (click to toggle)
phpdoc 20020310-1
links: PTS
area: main
in suites: woody
size: 35,272 kB
ctags: 354
sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (2656 lines) | stat: -rw-r--r-- 88,762 bytes
<?xml version="1.0" encoding="iso-8859-1"?>
 <reference id="ref.imap">
  <title>IMAP, POP3 und NNTP Funktionen</title>
  <titleabbrev>IMAP</titleabbrev>

  <partintro>
   <simpara>
    Dieses Paket baut auf auf der C-Client Bibliothek auf, die Sie
    unter der URL <ulink url="&url.imap;">&url.imap;</ulink> erhalten.
    Kompilieren Sie diese und kopieren Sie
    <filename>c-client/c-client.a</filename> nach
    <filename>/usr/local/lib/libc-client.a</filename> sowie
    <filename>c-client/rfc822.h</filename>, <filename>mail.h</filename>
    und <filename>linkage.h</filename> nach
    <filename>/usr/local/include</filename> oder in ein anderes
    Verzeichnis in Ihrem Link- bzw. Include-Pfad.
    Anschlieend konfigurieren und kompilieren Sie PHP mit der Option
    <option role="configure">--with-imap</option>.
   </simpara>
   <simpara>
    Beachten Sie, da diese Funktionen nicht auf das
    <acronym>IMAP</acronym> -Protokoll beschrnkt sind, auch wenn der
    Name dies vermuten lt.
    Die zugrundeliegende C-Client Bibliothek untersttzt auch
    <acronym>POP3</acronym>, <acronym>NNTP</acronym> und lokale
    Mailbox-Zugriffe.
   </simpara>
   <para>
    Diese Dokumentation kann nicht alle Bereiche beschreiben, die von
    den enthaltenen Funktionen berhrt werden. Weitergehende Informationen
    erhalten Sie in der Dokumentation der C-Client Bibliothek (Datei
    <filename>docs/internal.txt</filename> im Quellpaket der Bibliothek)
    sowie in folgenden RFC-Dokumenten:
    <itemizedlist>
     <listitem>
      <simpara>
       <ulink url="&url.rfc;rfc821.html">RFC821</ulink> :
       Simple Mail Transfer Protocol (SMTP)
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       <ulink url="&url.rfc;rfc822.html">RFC822</ulink> :
       Standard for ARPA internet text messages
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       <ulink url="&url.rfc;rfc2060.html">RFC2060</ulink> :
       Internet Message Access Protocol (IMAP) Version 4rev1
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       <ulink url="&url.rfc;rfc1939.html">RFC1939</ulink> :
       Post Office Protocol Version 3 (POP3)
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       <ulink url="&url.rfc;rfc977.html">RFC977</ulink> :
       Network News Transfer Protocol (NNTP)
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       <ulink url="&url.rfc;rfc2076.html">RFC2076</ulink> :
       Common Internet Message Headers
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       <ulink url="&url.rfc;rfc2045.html">RFC2045</ulink> ,
       <ulink url="&url.rfc;rfc2046.html">RFC2046</ulink> ,
       <ulink url="&url.rfc;rfc2047.html">RFC2047</ulink> ,
       <ulink url="&url.rfc;rfc2048.html">RFC2048</ulink> &amp;
       <ulink url="&url.rfc;rfc2049.html">RFC2049</ulink> :
       Multipurpose Internet Mail Extensions (MIME)
      </simpara>
     </listitem>
    </itemizedlist>
    Eine ausfhrliche bersicht bietet auch das Buch
    <ulink url="&url.email.book;">Programming Internet Email</ulink>
    von David Wood.
   </para>
  </partintro>

  <refentry id="function.imap-append">
   <refnamediv>
    <refname>imap_append</refname>
    <refpurpose>
     Fgt eine String-Nachricht an das angegebene Postfach an.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_append</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>mbox</parameter></methodparam>
      <methodparam><type>string</type><parameter>message</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Liefert &true; bei Erfolg und &false; bei Fehlern.
    </para>
    <para>
     <function>imap_append</function> fgt den String aus
     <parameter>message</parameter> als neue Nachricht an die
     durch  <parameter>mbox</parameter> spezifizierte Mailbox an. Wenn
     der optionale <parameter>flags</parameter> spezifiziert wird, so
     werden die Flags der Nachricht in der Mailbox entsprechend gesetzt.
    </para>
    <para>
     <example>
      <title><function>imap_append</function> Beispiel</title>
      <programlisting role="php">
$stream = imap_open ("{your.imap.host}INBOX.Drafts", "username", "password");

$check = imap_check ($stream);
print "Msg Count before append: " . $check->Nmsgs . "&lt;br>\n";

imap_append( $stream, "{your.imap.host}INBOX.Drafts"
                    , "From: me@my.host\r\n"
                    . "To: you@your.host\r\n"
                    . "Subject: test\r\n"
                    . "\r\n"
                    . "Das ist ein Test, bitte ignorieren\r\n"
                    );

$check = imap_check ($stream);
print "Msg Count after append : " . $check->Nmsgs . "&lt;br>\n";

imap_close ($stream);
      </programlisting>
     </example>
    </para>
    <warning>
     <para>
      Der Cyrus IMAP Server erwartet zwingend "\r\n" als
      Zeilenende-Kennung, ein einfaches "\n" wird nicht richtig
      verarbeitet.
     </para>
    </warning>
   </refsect1>
  </refentry>

  <refentry id="function.imap-base64">
   <refnamediv>
    <refname>imap_base64</refname>
    <refpurpose>Dekodiert BASE64-codierten Text</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_base64</methodname>
      <methodparam><type>string</type><parameter>text</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die <function>imap_base64</function> Funktion decodiert BASE64
     codierten Text (gem <ulink
     url="&url.rfc;rfc2045.html">RFC2045</ulink>, Abschnitt 6.8). Der
     decodierte Text wird als String zurckgegeben.
    </para>
    <para>
     Siehe auch <function>imap_binary</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-body">
   <refnamediv>
    <refname>imap_body</refname>
    <refpurpose>Liest den Krper einer Nachricht</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_body</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>imap_body</function> liefert den Krper der Nachricht
     mit der Nummer <parameter> msg_number</parameter> im aktuellen
     Postfach. Die optionalen <parameter>flags</parameter> knnen eine
     Bitmaske enthalten, die sich aus folgenden Werten zusammensetzt:
     <itemizedlist>
      <listitem>
       <simpara>
        FT_UID - <parameter>msg_number</parameter> ist eine UID
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        FT_PEEK - Das \Seen-Flag wird nicht beeinflut.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        FT_INTERNAL - Die Nachricht wird im internen Format
        zurckgegeben eine CRLF-Umwandlung findet nicht statt.
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-check">
   <refnamediv>
    <refname>imap_check</refname>
    <refpurpose>Prft den Status des aktuelle Postfachs</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>object</type><methodname>imap_check</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die <function>imap_check</function> Funktion prft den Status
     des aktuellen Postfach und liefert die entsprechenden Felder in
     einem Objekt mit folgenden Attributen zurck:
    </para>
    <para>
     <itemizedlist>
      <listitem>
       <simpara>
        Date - Datum der letzten nderung des Postfach-Inhalts
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        Driver - Zugriffsprotokoll: POP, IMAP, NNTP
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        Mailbox - Name des Postfachs
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        Nmsgs - Anzahl der Nachrichten im Postfach
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        Recent - Anzahl der neuen Nachrichten im Postfach
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
    <para>
     <example>
      <title><function>imap_check</function> Beispiel</title>
      <programlisting role="php">
$mbox = imap_open ("{your.imap.host}INBOX", "username", "password")
    || die ("can't connect: " . imap_last_error());

$check = imap_check ($mbox);

if($check) {
    print "Date: "     . $check->Date    . "&lt;br>\n" ;
    print "Driver: "   . $check->Driver  . "&lt;br>\n" ;
    print "Mailbox: "  . $check->Mailbox . "&lt;br>\n" ;
    print "Messages: " . $check->Nmsgs   . "&lt;br>\n" ;
    print "Recent: "   . $check->Recent  . "&lt;br>\n" ;
} else {
    print "imap_check() failed: " . imap_last_error() . "&lt;br>\n";
}

imap_close ($mbox);
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-close">
   <refnamediv>
    <refname>imap_close</refname>
    <refpurpose>Schliet eine IMAP-Verbindung</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_close</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Schliet eine IMAP-Verbindung. Mit dem optionalen
     <parameter>flag</parameter> CL_EXPUNGE kann ein Bereinigen
     (physikalisches Lschen aller zum Lschen markierten Nachrichten)
     ausgelst werden.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-createmailbox">
   <refnamediv>
    <refname>imap_createmailbox</refname>
    <refpurpose>Erzeugt ein neues Postfach</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_createmailbox</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>mbox</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>imap_createmailbox</function> legt ein ber den Parameter
     <parameter>mbox</parameter> spezifiziertes neues Postfach an.
    </para>
    <para>
     Liefert &true; bei Erfolg und &false; bei Fehlern.
    </para>
    <para>
     Siehe auch <function>imap_renamemailbox</function> and
     <function>imap_deletemailbox</function>
     sowie <function>imap_open</function> fr das Format des
     Parameters <parameter>mbox</parameter>.
    </para>
    <para>
     <example>
      <title><function>imap_createmailbox</function> Beispiel</title>
      <programlisting>
$mbox = imap_open ("{your.imap.host}", "username", "password", OP_HALFOPEN)
     || die ("can't connect: ".imap_last_error());

$name1 = "phpnewbox";
$name2 = imap_utf7_encode ("phpnewbx");

$newname = $name1;

echo "Newname will be '$name1'&lt;br>\n";

# we will now create a new mailbox "phptestbox" in your inbox folder,
# check its status after creation and finaly remove it to restore
# your inbox to its initial state

if (@imap_createmailbox ($mbox,imap_utf7_encode ("{your.imap.host}INBOX.$newname"))) {
    $status = @imap_status($mbox,"{your.imap.host}INBOX.$newname",SA_ALL);
    if($status) {
        print("your new mailbox '$name1' has the following status:&lt;br>\n");
        print("Messages:   ". $status->messages   )."&lt;br>\n";
        print("Recent:     ". $status->recent     )."&lt;br>\n";
        print("Unseen:     ". $status->unseen     )."&lt;br>\n";
        print("UIDnext:    ". $status->uidnext    )."&lt;br>\n";
        print("UIDvalidity:". $status->uidvalidity)."&lt;br>\n";

        if (imap_renamemailbox ($mbox,"{your.imap.host}INBOX.$newname", "{your.imap.host}INBOX.$name2")) {
            echo "renamed new mailbox from '$name1' to '$name2'&lt;br>\n";
            $newname=$name2;
        } else {
            print "imap_renamemailbox on new mailbox failed: ".imap_last_error ()."&lt;br>\n";
        }
    } else {
            print "imap_status on new mailbox failed: ".imap_last_error()."&lt;br>\n";
    }
    if (@imap_deletemailbox($mbox,"{your.imap.host}INBOX.$newname")) {
        print "new mailbox removed to restore initial state&lt;br>\n";
    } else {
        print  "imap_deletemailbox on new mailbox failed: ".implode ("&lt;br>\n", imap_errors())."&lt;br>\n";
    }

} else {

    print "could not create new mailbox: ".implode ("&lt;br>\n",imap_errors())."&lt;br>\n";
}

imap_close($mbox);
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-delete">
   <refnamediv>
    <refname>imap_delete</refname>
    <refpurpose>
     Merkt eine Nachricht des aktuellen Postfachs zum Lschen vor.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_delete</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion liefert immer &true;, eventuelle Fehler knnen nicht
     erkannt werden!
    </para>
    <para>
     Die <function>imap_delete</function> Funktion merkt die mit
     <parameter>msg_number</parameter> angegebene Nachricht des
     aktuellen Postfachs zum Lschen vor.  Enthlt der optionale
     Parameter <parameter>flags</parameter> den Wert
     <parameter>FT_UID</parameter>, so wird der Parameter
     <parameter>msg_number</parameter> als <parameter>UID</parameter>
     interpretiert.  Die Nachricht verbleibt zunchst noch im
     Postfach, endgltig gelscht wird sie (zusammen mit allen anderen
     entsprechend markierten Nachrichten) durch Aufruf der Funktion
     <function>imap_expunge</function> oder durch
     <function>imap_close</function> mit dem optionalen Flag
     <parameter>CL_EXPUNGE</parameter>.
    </para>
    <para>
     <example>
      <title><function>imap_delete</function> Beispiel</title>
      <programlisting role="php">
$mbox = imap_open ("{your.imap.host}INBOX", "username", "password")
    || die ("can't connect: " . imap_last_error());

$check = imap_mailboxmsginfo ($mbox);
print "Messages before delete: " . $check->Nmsgs . "&lt;br>\n" ;
imap_delete ($mbox, 1);
$check = imap_mailboxmsginfo ($mbox);
print "Messages after  delete: " . $check->Nmsgs . "&lt;br>\n" ;
imap_expunge ($mbox);
$check = imap_mailboxmsginfo ($mbox);
print "Messages after expunge: " . $check->Nmsgs . "&lt;br>\n" ;
imap_close ($mbox);
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-deletemailbox">
   <refnamediv>
    <refname>imap_deletemailbox</refname>
    <refpurpose>Lscht ein Postfach</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_deletemailbox</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>mbox</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>imap_deletemailbox</function> lscht das angegebene
     Postfach inclusive aller darin enthaltener Nachrichten und
     Unter-Postfcher.
    </para>
    <para>
     Liefert &true; bei Erfolg und &false; bei Fehlern.
    </para>
    <para>
     Siehe auch <function>imap_createmailbox</function> und
     <function>imap_renamemailbox</function>
     sowie <function>imap_open</function> fr das Format des
     <parameter>mbox</parameter> Parameters.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-expunge">
   <refnamediv>
    <refname>imap_expunge</refname>
    <refpurpose>
     Lscht alle zum Lschen vorgemerkten Nachrichten
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_expunge</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>imap_expunge</function> lscht endgltig alle von den
     Funktionen <function>imap_delete</function>,
     <function>imap_mail_move</function> oder
     <function>imap_setflag_full</function> zum Lschen vorgemerkten
     Nachrichten.
    </para>
    <para>
     Diese Funktion liefert immer &true;, eventuelle Fehler knnen nicht
     erkannt werden!
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-fetchbody">
   <refnamediv>
    <refname>imap_fetchbody</refname>
    <refpurpose>
     Liefert einen bestimmten Abschnitt aus dem Krper einer Nachricht.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_fetchbody</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
      <methodparam><type>string</type><parameter>part_number</parameter></methodparam>
      <methodparam choice="opt"><type>flags</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion liefert einen bestimmten Teil einer MIME-kodierten
     Nachricht als String. Die Nummer des gewnschten Teils besteht
     aus von Punkten getrennten Zahlen, die den Index des Teils
     gem der IMAP4-Spezifikationen bezeichnen. Der Inhalt wird dabei
     von dieser Funktion nicht dekodiert.
    </para>
    <para>
     Die Bitmaske <parameter>flags</parameter> kann aus folgenden
     Werten zusammengesetzt werden:
     <itemizedlist>
      <listitem>
       <simpara>
        FT_UID - <parameter>msg_number</parameter> enthlt eine UID
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        FT_PEEK - Das \Seen Flag der Nachricht wird nicht verndert
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        FT_INTERNAL - Das Ergebnis wird ohne jeden Versuch einer
        Konvertierung der Zeilenenden zurckgegeben
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-fetchstructure">
   <refnamediv>
    <refname>imap_fetchstructure</refname>
    <refpurpose>
     Liefert die Struktur der angegebenen Nachricht
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>object</type><methodname>imap_fetchstructure</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion liefert die gesamten Strukturinformationen zu
     einer gegebenen Nachricht. Das zurckgegebene Objekt enthlt den
     Umschlag, die internen Daten, Gre und Flags der Nachricht sowie
     ein (rekursives) Array von hnlichen Objekten fr jeden
     enthaltenen MIME-Teil der Nachricht. Enthlt der optionale
     Parameter <parameter>flags</parameter> den Wert
     <parameter>FT_UID</parameter>, so wird
     <parameter>msg_number</parameter> als UID anstelle eines Index
     interpretiert.
    </para>
    <para>
     Das zurckgegebene Objekt verfgt ber die folgenden Attribute:
     <table>
      <title>
       Zurckgegebene Objekte von <function>imap_fetchstructure</function>
      </title>
      <tgroup cols="2">
       <tbody>
        <row>
         <entry>type</entry>
         <entry>Primrer MIME-Typ des Nachrichten-Teils</entry>
        </row>
        <row>
         <entry>encoding</entry>
         <entry>Transfer-Kodierung</entry>
        </row>
        <row>
         <entry>ifsubtype</entry>
         <entry>Wahr, wenn das Feld subtype gesetzt ist</entry>
        </row>
        <row>
         <entry>subtype</entry>
         <entry><acronym>MIME</acronym> Subtyp</entry>
        </row>
        <row>
         <entry>ifdescription</entry>
         <entry>Wahr, wenn ein Beschreibungsstring existiert</entry>
        </row>
        <row>
         <entry>description</entry>
         <entry>Inhalt des Bechreibungsstrings</entry>
        </row>
        <row>
         <entry>ifid</entry>
         <entry>Wahr, wenn ein Identifikationsstring existiert</entry>
        </row>
        <row>
         <entry>id</entry>
         <entry>Identificationsstring</entry>
        </row>
        <row>
         <entry>lines</entry>
         <entry>Anzahl der Zeilen dieses Teils</entry>
        </row>
        <row>
         <entry>bytes</entry>
         <entry>Gre des Teils in Byte</entry>
        </row>
        <row>
         <entry>ifdisposition</entry>
         <entry>Wahr, wenn der Dispositionsstring gesetzt ist</entry>
        </row>
        <row>
         <entry>disposition</entry>
         <entry>Dispositionsstring</entry>
        </row>
        <row>
         <entry>ifdparameters</entry>
         <entry>Wahr, wenn Dispositions-Parameterwerte gesetzt sind</entry>
        </row>
        <row>
         <entry>dparameters</entry>
         <entry>Array der DispositionsParameter</entry>
        </row>
        <row>
         <entry>ifparameters</entry>
         <entry>Wahr, wenn Parameter gesetzt sind</entry>
        </row>
        <row>
         <entry>parameters</entry>
         <entry>Array der <acronym>MIME</acronym> Parameter</entry>
        </row>
        <row>
         <entry>parts</entry>
         <entry>
          Array von Objekten, die die einzelnen Unterteile der
          Nachricht beschreiben
         </entry>
        </row>
       </tbody>
      </tgroup>
     </table>
    </para>
    <note>
     <orderedlist>
      <listitem>
       <para>
        dparameters ist ein Array von Objekten mit jeweils einem
        "attribute" und einem "value" Attribut.
       </para>
      </listitem>
      <listitem>
       <para>
        parameters ist ein Array von Objekten mit jeweils einem
        "attribute" und einem "value" Attribut.
       </para>
      </listitem>
      <listitem>
       <para>
        Die Elemente des parts Array entsprechen dem von der Funktion
        zurckgegebenen Objekt (usf.).
       </para>
      </listitem>
     </orderedlist>
    </note>
    <para>
     <table>
      <title>Primary body type</title>
      <tgroup cols="2">
       <tbody>
        <row><entry>0</entry><entry>text</entry></row>
        <row><entry>1</entry><entry>multipart</entry></row>
        <row><entry>2</entry><entry>message</entry></row>
        <row><entry>3</entry><entry>application</entry></row>
        <row><entry>4</entry><entry>audio</entry></row>
        <row><entry>5</entry><entry>image</entry></row>
        <row><entry>6</entry><entry>video</entry></row>
        <row><entry>7</entry><entry>other</entry></row>
       </tbody>
      </tgroup>
     </table>
    </para>
    <para>
     <table>
      <title>Transfer encodings</title>
      <tgroup cols="2">
       <tbody>
        <row><entry>0</entry><entry>7BIT</entry></row>
        <row><entry>1</entry><entry>8BIT</entry></row>
        <row><entry>2</entry><entry>BINARY</entry></row>
        <row><entry>3</entry><entry>BASE64</entry></row>
        <row><entry>4</entry><entry>QUOTED-PRINTABLE</entry></row>
        <row><entry>5</entry><entry>OTHER</entry></row>
       </tbody>
      </tgroup>
     </table>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-header">
   <refnamediv>
    <refname>imap_header</refname>
    <refpurpose>Liefert den Kopf einer Nachricht</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>object</type><methodname>imap_header</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>fromlength</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>subjectlength</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>defaulthost</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion liefert ein Objekt, das aus verschiedenen
     Header-Elementen gebildet wird.
    </para>
    <para>
     <informalexample>
      <literallayout>
       remail, date, Date, subject, Subject, in_reply_to, message_id,
       newsgroups, followup_to, references

message flags:
   Recent -  'R' wenn neu und bereits gelesen,
             'N' wenn neu und noch nicht gelesen,
             ' ' wenn nicht neu
   Unseen -  'U' wenn noch nicht gelesen UND nicht neu,
             ' ' wenn gelesen OR neu und noch nicht gelesen
   Answered -'A' wenn beantwortet,
             ' ' sonst
   Deleted - 'D' wenn zum Lschen vorgemerkt
             ' ' sonst
   Draft -   'X' wenn als Entwurf markiert,
             ' ' sonst
   Flagged - 'F' wenn als 'wichtig' markiert,
             ' ' sonst

Beachten Sie bitte die etwas seltsame Recent/Unseen-Zuordnung.
Eine Nachricht wurde noch nicht gelesen, wenn folgende Bedingung
erfllt ist:

Unseen == 'U' || Recent == 'N'

toaddress (Inhalt der to: Zeile, bis zu 1024 Zeichen)

to[] (ein Array aus Objekten aus der to: Zeile, jeweils mit:)
   personal
   adl
   mailbox
   host

fromaddress (Inhalt der from: Zeile, up to 1024 characters)

from[] (Inhalt der From Zeile, bestehend aus:)
   personal
   adl
   mailbox
   host

ccaddress (Inhalt der  cc: Zeile, max. 1024 Zeichen)
cc[] (Inhalt der Cc Zeile, bestehend aus:)
   personal
   adl
   mailbox
   host

bccaddress (Inhalt der  bcc Zeile, max. 1024 Zeichen)
bcc[] (Inhalt der Bcc Zeile, bestehend aus:)
   personal
   adl
   mailbox
   host

reply_toaddress (Inhalt der  reply_to: Zeile, max. 1024 Zeichen)
reply_to[] (Inhalt der Reply_to Zeile, bestehend aus:)
   personal
   adl
   mailbox
   host

senderaddress (Inhalt der  sender: Zeile, max. 1024 Zeichen)
sender[] (Inhalt der sender Zeile, bestehend aus:)
   personal
   adl
   mailbox
   host

return_path (Inhalt der  return-path: Zeile, max. 1024 Zeichen)
return_path[] (Inhalt der return_path Zeile, bestehend aus:)
   personal
   adl
   mailbox
   host

udate (Sende-Zeitpunkt der Nachricht in Sekunden seit 1.1.1970)

fetchfrom (From: Zeile, formartiert auf
max. <parameter>fromlength</parameter> Zeichen)

fetchsubject (Subject: Zeile, formatiert auf
max. <parameter>subjectlength</parameter> Zeichen)
      </literallayout>
     </informalexample>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-headers">
   <refnamediv>
    <refname>imap_headers</refname>
    <refpurpose>
     Liefert eine Zusammenfassung aller Nachrichtenkpfe eines Postfachs
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>imap_headers</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion liefert ein String-Array, das je Nachricht
     einen String mit vorformatierten Informationen aus dem
     Nachrichtenheader enthlt.
     <!-- format -->
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-listmailbox">
   <refnamediv>
    <refname>imap_listmailbox</refname>
    <refpurpose>Liefert eine Liste der Postfach-Namen</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>imap_listmailbox</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>ref</parameter></methodparam>
      <methodparam><type>string</type><parameter>pat</parameter></methodparam>
     </methodsynopsis>
    <para>
     Liefert die Namen der gefundenen Postfcher als String-Array.
     <parameter>ref</parameter> und <parameter>pat</parameter> werden
     in <function>imap_getmailboxes</function> beschrieben.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-getmailboxes">
   <refnamediv>
    <refname>imap_getmailboxes</refname>
    <refpurpose>
     Liefert detailierte Informationen ber eine Auswahl von Postfchern
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>imap_getmailboxes</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>ref</parameter></methodparam>
      <methodparam><type>string</type><parameter>pat</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>imap_getmailboxes</function> liefert ein Array zurck,
     das fr jedes gefundene Postfach ein Objekt mit de Attributen
     <parameter>name</parameter>, <parameter>delimiter</parameter>
     und <parameter>attributes</parameter> enthlt.
     <parameter>name</parameter> enthlt dabei den vollstndigen
     Pfadnamen des Postfachs, <parameter>delimiter</parameter> das
     verwendete Trennzeichen zwischen Postfach-Ebenen,
     und <parameter>attributes</parameter> besteht aus einer Bitmaske,
     die einzelne Eigenschaften des Postfachs beschreibt:
     <itemizedlist>
      <listitem>
       <simpara>
        LATT_NOINFERIORS - es existieren keine weiteren Postfcher
        unterhalb dieses Postfachs
       </simpara>
      </listitem>
     <listitem>
       <simpara>
        LATT_NOSELECT - Dieses "Postfach" ist nur ein Behlter fr
        weitere Postfcher.
       </simpara>
       <simpara>
        Es kann selbst keine Nachrichten enthalten und somit auch
        nicht geffnet werden.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        LATT_MARKED - Dieses Postfach wurde markiert (nur bei UW-IMAPD).
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        LATT_UNMARKED - Dieses Postfach wurde nicht markiert (nur bei UW-IMAPD).
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
    <para>
     Namen von Postfchern, die Zeichen auerhalb des druckbaren
     ASCII-Bereiches enthalten, knnen mit Hilfe der Funktion
     <function>imap_utf7_decode</function> dekodiert werden.
    </para>
    <para>
     <parameter>ref</parameter> sollte normalerweise nur die
     Spezifikation des Servers in der in
     <function>imap_open</function> beschriebenen Form enthalten.
     ber <parameter>pat</parameter> kann ein Startpunkt innerhalb der
     Postfach-Hierachie vorgegeben werden. Wnschen Sie die Ausgabe
     aller Postfcher, so bergeben Sie als <parameter>pat</parameter>
     '*'.
    </para>
    <para>
     Die Zeichen '*' und '%' haben innerhalb von
     <parameter>pattern</parameter> eine besondere Bedeutung:
     <itemizedlist>
      <listitem>
       <simpara>
        '*' - entspricht beliebig vielen Zeichen (incl. des
        Trennzeichens zw. Postfach-Namen)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        '%' - entspricht beliebig vielen Zeichen innerhalb eines
        Postfach-Namens
       </simpara>
      </listitem>
     </itemizedlist>
     So liefert "*" alle verfgbaren Postfcher auf dem Server,
     "INBOX/*" dementsprechend alle persnlichen Postfcher des
     aktuellen Benutzers.  "%" dagegen liefert nur die
     Toplevel-Postfcher des Servers, "INBOX/%" dementsprechend nur
     die Toplevel-Postfcher des aktuellen Benutzers.  Ein '%' am Ende
     von <parameter>pattern</parameter> entspricht zustzlich auch
     allen Zeichenfolgen, die mit dem Trennzeichen beginnen.
    </para>
    <para>
     <example>
      <title><function>imap_getmailboxes</function> Beispiel</title>
      <programlisting role="php">
$mbox = imap_open ("{your.imap.host}", "username", "password", OP_HALFOPEN)
    || die ("can't connect: " . imap_last_error());

$list = imap_getmailboxes ($mbox, "{your.imap.host}", "*");
if (is_array ($list)) {
    reset ($list);
    while (list( $key, $val) = each ($list)) {
        print "($key) ";
        print imap_utf7_decode ($val->name) . ",";
        print "'" . $val->delimiter . "',";
        print $val->attributes . "&lt;br>\n";
    }
} else {
    print "imap_getmailboxes failed: " . imap_last_error() . "\n";
}
imap_close ($mbox);
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-listsubscribed">
   <refnamediv>
    <refname>imap_listsubscribed</refname>
    <refpurpose>
     Liefert eine Liste aller abbonierten Postfcher
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>imap_listsubscribed</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>ref</parameter></methodparam>
      <methodparam><type>string</type><parameter>pattern</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion entspricht weitgehend
     <function>imap_listmailbox</function>, allerdings werden nur
     Postfcher zurckgegeben, die der aktuelle Benutzer auch
     abboniert hat.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-getsubscribed">
   <refnamediv>
    <refname>imap_getsubscribed</refname>
    <refpurpose>
     Liefert eine Auswahl aller abbonierten Postfcher
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>imap_getsubscribed</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>ref</parameter></methodparam>
      <methodparam><type>string</type><parameter>pattern</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion entspricht weitgehend
     <function>imap_getmailboxes</function>, allerdings werden nur
     Postfcher zurckgegeben, die der aktuelle Benutzer auch
     abboniert hat.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-mail-copy">
   <refnamediv>
    <refname>imap_mail_copy</refname>
    <refpurpose>Kopiert Nachrichten in ein Postfach</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_mail_copy</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>msglist</parameter></methodparam>
      <methodparam><type>string</type><parameter>mbox</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion kopiert die in <parameter>msglist</parameter>
     angegebenen Nachrichten in das Postfach <parameter>mbox</parameter>.
     <parameter>msglist</parameter> kann eine einzelne Nachrichtennummer
     oder Aufzhlungen und Bereiche gem
     <ulink url="&url.rfc;rfc2060.html">RFC2060</ulink> enthalten.
    </para>
    <para>
     Die Bitmaske <parameter>flags</parameter> kann aus den foldengen
     Werten zusammengesetzt werden.
     <itemizedlist>
      <listitem>
       <simpara>
        CP_UID - Die Nummern in <parameter>msglist</parameter>
        entsprechen den UIDs der gewnschten Nachrichten
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        CP_MOVE - Die ursprunglichen Nachrichten werden nach dem
        Kopieren gelscht.  copying
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
    <para>
     Liefert &true; bei Erfolg und &false; bei Fehlern.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-mail-move">
   <refnamediv>
    <refname>imap_mail_move</refname>
    <refpurpose>
     Verschiebt Nachrichten in ein anderes Postfach
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_mail_move</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>msglist</parameter></methodparam>
      <methodparam><type>string</type><parameter>mbox</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion verschiebt die in <parameter>msglist</parameter>
     angegebenen Nachrichten in das Postfach <parameter>mbox</parameter>.
     <parameter>msglist</parameter> kann eine einzelne Nachrichtennummer
     oder Aufzhlungen und Bereiche gem
     <ulink url="&url.rfc;rfc2060.html">RFC2060</ulink> enthalten.
    </para>
    <para>
     Die Bitmaske <parameter>flags</parameter> kann den foldengen
     Wert enthalten:
     <itemizedlist>
      <listitem>
       <simpara>
        CP_UID - Die Nummern in <parameter>msglist</parameter>
        entsprechen den UIDs der gewnschten Nachrichten
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
    <para>
     Liefert &true; bei Erfolg und &false; bei Fehlern.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-num-msg">
   <refnamediv>
    <refname>imap_num_msg</refname>
    <refpurpose>
     Liefert die Anzahl der Nachrichten im aktuellen Postfach
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_num_msg</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
     </methodsynopsis>
    <para>
     Liefert die Anzahl der Nachrichten im aktuellen Postfach
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-num-recent">
   <refnamediv>
    <refname>imap_num_recent</refname>
    <refpurpose>
     Liefert die Anzahl der neu hinzugekommenen Nachrichten
     im aktuellen Postfach
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_num_recent</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
     </methodsynopsis>
    <para>
     Liefert die Anzahl der neu hinzugekommenen Nachrichten
     im aktuellen Postfach
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-open">
   <refnamediv>
    <refname>imap_open</refname>
    <refpurpose>
     ffnet eine Verbindung zu einem Postfach auf einem POP-, IMAP-
     oder NNTP-Server
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_open</methodname>
      <methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
      <methodparam><type>string</type><parameter>username</parameter></methodparam>
      <methodparam><type>string</type><parameter>password</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion liefert ein Verbindungs-Handle bzw. &false; bei
     evtl.  auftretenden Fehlern. Verbindungen knnen nicht nur zu
     IMAP-, sondern auch zu POP- oder NNTP-Servern aufgebaut werden,
     wobei dann allerdings nicht der gesamte Funktionsumfang zur
     Verfgung steht.  Liefert ein IMAP-Streamhandle oder &false; bei
     Fehlern.
    </para>
    <para>
     Der Name eines Postfachs setzt sich zusammen aus der Bezeichnung
     des Servers und dem Pfad des Postfachs auf diesem Server. Der
     spezielle Name INBOX steht dabei als Synonym fr das persnliche
     Postfach des jeweiligen Benutzers. Die Bezeichnung des Servers
     setzt sich zusammen aus dem eigentlichen Servernamen oder der
     entsprechenden IP-Adresse sowie das gewnschte Protokoll
     (getrennt durch '/') und optional der zu benutzende Port
     (getrennt durch ':'). Die gesamte Serverbezeichnung wird in '{'
     und '}' eingeschlossen und mu immer mit angegeben
     werden. Enthlt der Name eines Postfachs Zeichen auerhalb des
     druckbaren ASCII-Bereiches wie z.B. Umlaute oder das '', so mu
     er mit Hilfe der Funktion <function>imap_utf7_encode</function>
     codiert werden.
    </para>
    <para>
     Der optionale Parameter <parameter>flags</parameter> kann sich
     aus den folgenden Bitmasken zusammensetzen:
     <itemizedlist>
      <listitem>
       <simpara>
        OP_READONLY - ber diese Verbindung darf nur lesend
        zugegriffen werden
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        OP_ANONYMOUS - Bei NNTP-Verbindungen wird die Datei .newsrc
        nicht aktualisiert
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        OP_HALFOPEN - es wird eine IMAP- oder NNTP-Verbindung
        aufgebaut, aber noch kein Postfach ausgewhlt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        CL_EXPUNGE - beim Schlieen der Verbindung werden alle zum
        Lschen vorgemerkte Nachrichten endgltig gelscht (siehe auch
        <function>imap_delete</function> und
        <function>imap_expunge</function>)
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
    <para>
     Das folgende Beispiel stellt eine Verbindung zu einem
     lokalen IMAP-Server (IMAP = Port 143) her:
     <informalexample>
      <programlisting role="php">
$mbox = imap_open ("{localhost:143}INBOX", "user_id", "password");
      </programlisting>
     </informalexample>
     Eine Verbindung zu einem lokalen POP3-Server (POP3 = Port 110)
     erhalten sie mit:
     <informalexample>
      <programlisting role="php">
$mbox = imap_open ("{localhost/pop3:110}INBOX", "user_id", "password");
      </programlisting>
     </informalexample>
     Eine Verbindung zu einem lokalen News-Server (NNTP = Port 119)
     erhalten Sie mit:
     <informalexample>
      <programlisting role="php">
$nntp = imap_open ("{localhost/nntp:119}comp.test", "", "");
      </programlisting>
     </informalexample>
     Eine Verbindung zu einem nicht lokalen Server knnen Sie
     herstellen, indem Sie in den oben genannten Beispielen
     "localhost" durch den Namen oder die IP-Adresse des Servers
     ersetzen.
    </para>
    <para>
     <example>
      <title><function>imap_open</function> Beispiel</title>
      <programlisting>
$mbox = imap_open ("{your.imap.host:143}", "username", "password");

echo "&lt;p>&lt;h1>Mailboxes&lt;/h1>\n";
$folders = imap_listmailbox ($mbox, "{your.imap.host:143}", "*");
if ($folders == false)
    echo "Call failed&lt;br>\n";
else
    while (list ($key, $val) = each ($folders))
        echo $val . "&lt;br>\n";

echo "&lt;p>&lt;h1>Headers in INBOX&lt;/h1>\n";
$headers = imap_headers ($mbox);
if ($headers == false)
    echo "Call failed&lt;br>\n";
else
    while (list ($key, $val) = each ($headers))
        echo $val . "&lt;br>n";

imap_close ($mbox);
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-ping">
   <refnamediv>
    <refname>imap_ping</refname>
    <refpurpose>
     Prft, ob die aktuelle Verbindung noch verfgbar ist
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_ping</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
     </methodsynopsis>
    <para>
     Liefert &true;, wenn die aktuelle Verbindung noch verfgbar ist,
     sonst &false;.
    </para>
    <para>
     Die <function>imap_ping</function> Funktion schickt ein
     Ping-Signal an den Mailserver und prft so die Verfgbarkeit der
     Verbindung.  Auf diese Weise kann die Verbindung zu einem Server
     aufrechterhalten werden, der Verbindungen nach einer gewissen
     Zeit ohne Aktivitt automatisch beendet (da PHP-Scripte
     i.A. nicht sehr lange laufen, kann ich mir kaum vorstellen, das
     jemand diese Funktion wirklich bentigt).
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-renamemailbox">
   <refnamediv>
    <refname>imap_renamemailbox</refname>
    <refpurpose>ndert den Namen eines Postfachs</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_renamemailbox</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>old_mbox</parameter></methodparam>
      <methodparam><type>string</type><parameter>new_mbox</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>imap_renamemailbox</function> ndert
     den Namen eines Postfachs.
    </para>
    <para>
     Liefert &true; bei Erfolg und &false; bei Fehlern.
    </para>
    <para>
     Siehe auch <function>imap_createmailbox</function> und
     <function>imap_deletemailbox</function> sowie
     <function>imap_open</function> fr das Format der Parameter
     <parameter>old_mbox</parameter> und
     <parameter>new_mbox</parameter>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-reopen">
   <refnamediv>
    <refname>imap_reopen</refname>
    <refpurpose>Wechselt das aktuelle Postfach der Verbindung</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_reopen</methodname>
      <methodparam><type>string</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Mit Hilfe dieser Funktion kann auf IMAP- und NNTP-Servern ein
     anderes Postfach als das bisher aktuelle ausgewhlt werden.
    </para>
    <para>
     Der optionale Parameter <parameter>flags</parameter> kann sich
     aus den folgenden Bitmasken zusammensetzen:
     <itemizedlist>
      <listitem>
       <simpara>
        OP_READONLY - Auf das Postfach soll nur lesend zugegriffen
        werden
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        OP_ANONYMOUS - Bei NNTP-Verbindungen wird die persnliche
        .newsrc Datei nicht aktualisiert
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        OP_HALFOPEN - bei IMAP- oder NNTP-Servern wird in den
        allgemeinen Verbindungsstatus ohne aktuelles Postfach
        zurckgeschaltet
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        CL_EXPUNGE - beim Schlieen der Verbindung werden alle zum
        Lschen vorgemerkte Nachrichten endgltig gelscht (siehe auch
        <function>imap_delete</function> und
        <function>imap_expunge</function>)
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
    <para>
     Liefert &true; bei Erfolg und &false; bei Fehlern.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-subscribe">
   <refnamediv>
    <refname>imap_subscribe</refname>
    <refpurpose>Abbonieren eines Postfachs</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_subscribe</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>mbox</parameter></methodparam>
     </methodsynopsis>
    <para>
     Abbonieren eines Postfachs.
    </para>
    <para>
     Liefert &true; bei Erfolg und &false; bei Fehlern.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-undelete">
   <refnamediv>
    <refname>imap_undelete</refname>
    <refpurpose>
     Nimmt eine bereits gesetzte Lschmarkierung einer Nachricht
     zurck
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_undelete</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion nimmt eine evtl. durch die Funktionen
     <function>imap_delete</function> oder
     <function>imap_mail_move</function> gesetzte Lschmarkierung
     fr die durch <parameter>msg_number</parameter> spezifizierte
     Nachricht zurck.
    </para>
    <para>
     Liefert &true; bei Erfolg und &false; bei Fehlern.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-unsubscribe">
   <refnamediv>
    <refname>imap_unsubscribe</refname>
    <refpurpose>Abbonement eines Postfachs beenden</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_unsubscribe</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>mbox</parameter></methodparam>
     </methodsynopsis>
    <para>
     Abbonement eines Postfachs beenden.
    </para>
    <para>
     Liefert &true; bei Erfolg und &false; bei Fehlern.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-qprint">
   <refnamediv>
    <refname>imap_qprint</refname>
    <refpurpose>
     Konvertiert einen quoted-printable kodierten String
     in einen 8bit-String
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_qprint</methodname>
      <methodparam><type>string</type><parameter>string</parameter></methodparam>
     </methodsynopsis>
    <para>
     Konvertiert einen quoted-printable kodierten String
     (gem <ulink url="&url.rfc;rfc2045.html">RFC2045</ulink>,
     Abschnitt 6.7) in einen 8bit-String.
    </para>
    <para>
     Siehe auch <function>imap_8bit</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-8bit">
   <refnamediv>
    <refname>imap_8bit</refname>
    <refpurpose>
     Konvertiert einen String in einen quoted-printable kodierten String.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_8bit</methodname>
      <methodparam><type>string</type><parameter>string</parameter></methodparam>
     </methodsynopsis>
    <para>
     Konvertiert einen String in einen quoted-printable kodierten String
     (gem <ulink url="&url.rfc;rfc2045.html">RFC2045</ulink>,
     Abschnitt 6.7).
    </para>
    <para>
     Siehe auch <function>imap_qprint</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-binary">
   <refnamediv>
    <refname>imap_binary</refname>
    <refpurpose>
     Konvertiert 8Bit-Text in einen BASE64-kodierten String.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_binary</methodname>
      <methodparam><type>string</type><parameter>string</parameter></methodparam>
     </methodsynopsis>
    <para>
     Konvertiert 8Bit-Text in einen BASE64-kodierten String
     (gem <ulink url="&url.rfc;rfc2045.html">RFC2045</ulink>,
     Abschnitt 6.8).
    </para>
    <para>
     Siehe auch <function>imap_base64</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-scanmailbox">
   <refnamediv>
    <refname>imap_scanmailbox</refname>
    <refpurpose>
     Druchsucht Postfcher nach einen String
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>imap_scanmailbox</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>ref</parameter></methodparam>
      <methodparam><type>string</type><parameter>pat</parameter></methodparam>
      <methodparam><type>string</type><parameter>content</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion arbeitet hnlich wie
     <function>imap_listmailbox</function>.  Sie gibt aber nur die
     Namen der Postfcher zurck, in denen irgendwo der Text
     <parameter>content</parameter> vorkommt.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-mailboxmsginfo">
   <refnamediv>
    <refname>imap_mailboxmsginfo</refname>
    <refpurpose>
     Liefert Informationen ber das aktuelle Postfach
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>object</type><methodname>imap_mailboxmsginfo</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion liefert dieselben Informationen wie
     <function>imap_status</function> sowie zustzlich die Gre
     des Postfachs in Bytes. Diese wird aus der Summe der Gre der
     einzelnen Nachrichten gebildet, deshalb bentigt diese Funktion
     mehr Zeit zur Ausfhrung als <function>imap_status</function>.
    </para>
    <para>
     <table>
       <title>Felder des Rckgabe-Objekts</title>
       <tgroup cols="2">
        <tbody>
        <row>
         <entry>Date   </entry>
         <entry>Datum der letzten nderung    </entry>
        </row>
        <row>
         <entry>Driver </entry>
         <entry>Driver                        </entry>
        </row>
        <row>
         <entry>Mailbox</entry>
         <entry>Name des Postfachs            </entry>
        </row>
        <row>
         <entry>Nmsgs  </entry>
         <entry>Anzahl der Nachrichten        </entry>
        </row>
        <row>
         <entry>Recent </entry>
         <entry>Anzahl neuer Nachrichten      </entry>
        </row>
        <row>
         <entry>Unread </entry>
         <entry>Anzahl ungelesener Nachrichten</entry>
        </row>
        <row>
         <entry>Size   </entry>
         <entry>Gre des Postfachs in Byte   </entry>
        </row>
       </tbody>
      </tgroup>
     </table>
    </para>
    <para>
     <example>
      <title><function>imap_mailboxmsginfo</function> Beispiel</title>
      <programlisting role="php">
$mbox = imap_open ("{your.imap.host}INBOX", "username", "password")
    || die ("can't connect: " . imap_last_error());

$check = imap_mailboxmsginfo ($mbox);

if ($check) {
    print "Date: "     . $check->Date    . "&lt;br>\n";
    print "Driver: "   . $check->Driver  . "&lt;br>\n";
    print "Mailbox: "  . $check->Mailbox . "&lt;br>\n";
    print "Messages: " . $check->Nmsgs   . "&lt;br>\n" ;
    print "Recent: "   . $check->Recent  . "&lt;br>\n";
    print "Size: "     . $check->Size    . "&lt;br>\n";
} else {
    print "imap_check() failed: " . imap_lasterror() . "&lt;br>\n";
}
imap_close ($mbox);
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-rfc822-write-address">
   <refnamediv>
    <refname>imap_rfc822_write_address</refname>
    <refpurpose>
     Bildet aus Realnamen, Postfach und Server eine korekt
     formatierte Mail-Adresse
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_rfc822_write_address</methodname>
      <methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
      <methodparam><type>string</type><parameter>host</parameter></methodparam>
      <methodparam><type>string</type><parameter>personal</parameter></methodparam>
     </methodsynopsis>
    <para>
     Bildet aus Realnamen, Postfach und Server eine korekt
     formatierte Mail-Adresse gem
     <ulink url="&url.rfc;rfc822.html">RFC822</ulink>.
    </para>
    <para>
     <example>
      <title>
       <function>imap_rfc822_write_address</function> Beispiel
      </title>
      <programlisting role="php">
print imap_rfc822_write_address ("hartmut", "cvs.php.net",
                                 "Hartmut Holzgraefe);
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-rfc822-parse-adrlist">
   <refnamediv>
    <refname>imap_rfc822_parse_adrlist</refname>
    <refpurpose>Parsen eines Adress-Strings</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>imap_rfc822_parse_adrlist</methodname>
      <methodparam><type>string</type><parameter>address</parameter></methodparam>
      <methodparam><type>string</type><parameter>default_host</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion zerlegt einen Adress-String gem
     <ulink url="&url.rfc;rfc822.html">RFC822</ulink> und liefert
     ein Array von Objekten mit einem Eintrag je erkannter Adresse.
     Die Address-Objekte bestehen dabei jeweils aus den folgenden
     vier String-Elementen:
    </para>
    <para>
     <itemizedlist>
      <listitem>
       <simpara>
        mailbox - Name des Postfachs (Username)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        host - Hostname
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        personal - Realer Name des Empfngers
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        adl - at domain source route
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
    <para>
     <example>
      <title>
       <function>imap_rfc822_parse_adrlist</function> Beispiel
      </title>
      <programlisting role="php">
$address_string = "Hartmut Holzgraefe &lt;hartmut@php.net>,
                   postmaster@somedomain.net, root";
$address_array  = imap_rfc822_parse_adrlist ($address_string,
                                             "somedomain.net");
if (! is_array ($address_array)) die ("somethings wrong\n");

reset ($address_array);
while (list( $key, $val) = each ($address_array)) {
    print "mailbox : " . $val->mailbox  . "&lt;br>\n";
    print "host    : " . $val->host     . "&lt;br>\n";
    print "personal: " . $val->personal . "&lt;br>\n";
    print "adl     : " . $val->adl      . "&lt;p>\n";
}
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-setflag-full">
   <refnamediv>
    <refname>imap_setflag_full</refname>
    <refpurpose>Setzt Flags einer Nachricht</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_setflag_full</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>sequence</parameter></methodparam>
      <methodparam><type>string</type><parameter>flag</parameter></methodparam>
      <methodparam><type>string</type><parameter>options</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion setzt die bergebenen Flags fr eine oder mehrere
     Nachrichten.
    </para>
    <para>
     Mgliche Flags sind "\\Seen", "\\Answered", "\\Flagged",
     "\\Deleted", "\\Draft", und "\\Recent" (siehe auch <ulink
     url="&url.rfc;rfc2060.html">RFC2060</ulink>)
    </para>
    <para>
     Enthlt <parameter>options</parameter> den Wert ST_UID, so werden
     die bergebenen Nachrichtennummern als UIDs anstelle von Indizes
     interpretiert.
    </para>
    <para>
     <example>
      <title><function>imap_setflag_full</function> Beispiel</title>
      <programlisting role="php">
$mbox = imap_open ("{your.imap.host:143}", "username", "password")
     || die ("can't connect: " . imap_last_error());

$status = imap_setflag_full ($mbox, "2,5", "\\Seen \\Flagged");
if (!$status) echo imap_last_error();

imap_close ($mbox);
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-clearflag-full">
   <refnamediv>
    <refname>imap_clearflag_full</refname>
    <refpurpose>Lscht Flags einer Nachricht</refpurpose>
    </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_clearflag_full</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>sequence</parameter></methodparam>
      <methodparam><type>string</type><parameter>flag</parameter></methodparam>
      <methodparam><type>string</type><parameter>options</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion lscht die bergebenen Flags fr eine oder mehrere
     Nachrichten.
    </para>
    <para>
     Mgliche Flags sind "\\Seen", "\\Answered", "\\Flagged",
     "\\Deleted", "\\Draft", und "\\Recent" ( siehe auch <ulink
     url="&url.rfc;rfc2060.html">RFC2060</ulink>)
    </para>
    <para>
     Enthlt <parameter>options</parameter> den Wert ST_UID, so werden
     die bergebenen Nachrichtennummern als UIDs anstelle von Indizes
     interpretiert.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-sort">
   <refnamediv>
    <refname>imap_sort</refname>
    <refpurpose>Sortiert Nachrichten eines Postfachs</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>imap_sort</methodname>
      <methodparam><type>int</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>criteria</parameter></methodparam>
      <methodparam><type>int</type><parameter>reverse</parameter></methodparam>
      <methodparam><type>int</type><parameter>options</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion liefert die Indizes der Nachrichten eines
     Postfachs als sortiertes Array zurck. Als Sortier-Kriterium
     kann im Parameter <parameter>criteria</parameter> genau einer
     der folgenden Werte angegeben werden
     <itemizedlist>
      <listitem><simpara>
       SORTDATE        Versanddatum der Nachricht
      </simpara></listitem>
      <listitem><simpara>
       SORTARRIVAL     Empfangsdatum der Nachricht
      </simpara></listitem>
      <listitem><simpara>
       SORTFROM        Benutzername des ersten From: Eintrags
      </simpara></listitem>
      <listitem><simpara>
       SORTSUBJECT     Betreff der Nachricht
      </simpara></listitem>
      <listitem><simpara>
       SORTTO          Benutzername des ersten To: Eintrags
      </simpara></listitem>
      <listitem><simpara>
       SORTCC          Benutzername des ersten CC: Eintrags
      </simpara></listitem>
      <listitem><simpara>
       SORTSIZE        Gre der Nachricht in Bytes
      </simpara></listitem>
     </itemizedlist>
    </para>
    <para>
     Ist <parameter>reverse</parameter> ungleich 0, so werden
     die Nachrichten in umgekehrter Reihenfolge bergeben.
    </para>
    <para>
     Die Bitmaske <parameter>options</parameter> kann aus folgenden
     werten zusammengesetzt werden:
     <itemizedlist>
      <listitem>
       <simpara>
        SE_UID          Es werden UIDs anstelle von Indizes zurckgegeben
      </simpara>
      </listitem>
      <listitem>
       <simpara>
        SE_NOPREFETCH   Es werden keine Nachrichten im Cache gehalten
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-fetchheader">
   <refnamediv>
    <refname>imap_fetchheader</refname>
    <refpurpose>Liefert den Kopf einer Nachricht</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_fetchheader</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>msgno</parameter></methodparam>
      <methodparam><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion liefert den vollstndigen, ungefilterten und gem
     <ulink url="&url.rfc;rfc822.html">RFC 822</ulink> formatierten
     Kopf einer Nachricht als String zurck.
    </para>
    <para>
     Die Bitmaske <parameter>flags</parameter> kann aus folgenden
     Werten zusammengesetzt werden:
     <itemizedlist>
      <listitem>
       <simpara>
        FT_UID          <parameter>msgno</parameter> enthlt eine UID
      </simpara>
      </listitem>
      <listitem>
       <simpara>
        FT_INTERNAL     Der Kopf wird im "internen" Format, d.h.
                        ohne jegliche Konvertierung von Zeilenenden
                        zurckgegeben
      </simpara>
      </listitem>
      <listitem>
       <simpara>
        FT_PREFETCHTEXT Der Krper der Nachricht wird ebenfalls angefordert,
                        hierdurch wird ein zus. Zugriff vermieden, wenn z.B.
                        fr eine Save-Operation der gesamte Text einer
                        Nachricht bentigt wird
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-uid">
   <refnamediv>
    <refname>imap_uid</refname>
    <refpurpose>
     Liefert die UID zu einem gegeben Nachrichten-Index
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_uid</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>msgno</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion ermittelt die UID zu einem gegebenen
     Nachrichten-Index. Whrend die Nachrichten-Indices einfach
     von eins an aufsteigend durchnummeriert sind und sich z.B.
     bei Lschoperationen ndern knnen, ist die UID einer Nachricht
     innerhalb eines Postfachs unvernderbar eindeutig.
     ( Siehe auch <function>imap_msgno</function>).
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-msgno">
   <refnamediv>
    <refname>imap_msgno</refname>
    <refpurpose>
     Liefert den aktuellen Nachrichten-Index zu einer UID
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>imap_msgno</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>uid</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion liefert den aktuellen Index einer Nachricht
     innerhalb eines Postfachs aus der eindeutigen UID. Sie ist somit
     die Umkehrung der Funktion <function>imap_uid</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-search">
   <refnamediv>
    <refname>imap_search</refname>
    <refpurpose>
     Sucht Nachrichten, die den bergebenen Suchkriterien entsprechen
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>imap_search</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>criteria</parameter></methodparam>
      <methodparam><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion durchsucht die Nachrichten des aktuellen Postfachs
     und liefert ein Array mit den Nummern der Nachrichten, die mit den
     angegebenen Kriterien bereinstimmen.
     Der Parameter <parameter>criteria</parameter> enthlt einen String,
     der sich aus den folgenden Suchbegriffen zusammensetzen kann
     <itemizedlist>
      <listitem>
       <simpara>
        ALL - liefert alle Nachrichten, die den restlichen Kriterien
        entsprechen
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        ANSWERED - das \\ANSWERED Flag der Nachricht ist gesetzt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        BCC "string" - Das Bcc: Feld der Nachricht enthlt "string"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        BEFORE "date" - Das Date: Feld der Nachricht enthlt ein
        Datum, das vor dem in "date" angegebenen liegt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        BODY "string" - Im Inhalt der Nachricht ist "string" enthalten
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        CC "string" - Das Cc: Feld der Nachricht enthlt "string"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        DELETED - Die Nachricht ist zum Lschen vorgemerkt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        FLAGGED - Das \\FLAGGED (wichtig bzw. dringend) Flag der
        Nachricht ist gesetzt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        FROM "string" - Das From: Feld der Nachricht enthlt "string"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        KEYWORD "string" - Das Feld Keyword: enthlt "string"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        NEW - die Nachricht ist neu
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        OLD - die Nachricht ist nicht neu
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        ON "date" - Das Datum in Date: entspricht "date"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        RECENT - Das \\RECENT Flag ist gesetzt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        SEEN - Das \\SEEN Flag ist gesetzt, die Nachricht wurde
        bereits einmal abgerufen
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        SINCE "date" - Das Datum "date" liegt vor dem im Date: Feld
        der Nachricht
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        SUBJECT "string" - "string" ist Teil des Betreffs der
        Nachricht
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        TEXT "string" - "string" ist Teil der Nachricht (Kopf oder
        Inhalt)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        TO "string" - Das To: Feld der Nachricht enthlt "string"
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        UNANSWERED - Die Nachricht wurde nicht beantwortet, das
        \\Answered Flag ist nicht gesetzt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        UNDELETED - Die Nachricht ist nicht zum Lschen vorgemerkt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        UNFLAGGED - Die Nachricht ist nicht als 'wichtig' markiert
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        UNKEYWORD "string" - "string" ist nicht Schlsselwort der
        Nachricht
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        UNSEEN - Die Nachricht wurde bisher nicht gelesen
       </simpara>
      </listitem>
     </itemizedlist>
     Argumente, die Leerzeichen enthalten, mssen dabei in
     Anfhrungszeichen eingebettet werden.
    </para>
    <para>
     Um zum Beispiel alle unbeantworteten Nachrichten von Mama zu
     finden bergeben Sie als <parameter>criteria</parameter>:
     "UNANSWERED FROM Mama".  Die Suche scheint nicht zwischen Gro-
     und Kleinschreibung zu unterscheiden.  Die Liste der Suchbegriffe
     entstand nach Inspektion der UW c-client Sourcen und ist
     vermutlich nicht vollstndig (siehe auch <ulink
     url="&url.rfc;rfc2060.html">RFC 2060</ulink>, Abschnitt 6.4.4).
    </para>
    <para>
     Enthlt der optionale Parameter <parameter>flags</parameter> den
     Wert SE_UID, so werden UIDs anstelle von laufenden
     Nachrichtennummern zurckgegeben.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-last-error">
   <refnamediv>
    <refname>imap_last_error</refname>
    <refpurpose>
     Diese Funktion liefert die zuletzt whrend dieses Seitenzugriffs
     aufgetretene Fehlermeldung (falls vorhanden)
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_last_error</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Diese Funktion liefert den vollstndigen Text der zuletzt
     aufgetretenen Fehlermeldung dieses Requests.  Der Zustand des
     Fehlerstacks wird durch diese Funktion nicht verndert, weitere
     Aufrufe von <function>imap_last_error</function> liefern somit
     weiter dasselbe Ergebis, solange keine weiteren Fehler
     aufgetreten sind.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-errors">
   <refnamediv>
    <refname>imap_errors</refname>
    <refpurpose>
     Diese Funktion liefert alle bisher aufgetretenen Fehlermeldungen
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>imap_errors</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Diese Funktion liefert in Form eines String-Arrays alle seit
     Beginn des Requests bzw. seit dem letzten Aufruf von
     <function>imap_errors</function> aufgetretenen Fehlermeldung.
     Der Fehler-Stack wird dabei gelscht, so da folgende Aufrufe
     von <function>imap_errors</function> bzw.
     <function>imap_last_errors</function> bis zum mchsten
     aufgetretenen Fehler kein Ergebnis liefern.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-alerts">
   <refnamediv>
    <refname>imap_alerts</refname>
    <refpurpose>
     Diese Funktion liefert alle alert-Meldungen zurck, die whrend
     der Ausfhrung dieses Requests bzw. seit dem letzten Reset des
     alert-Stacks aufgetreten sind.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>imap_alerts</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Diese Funktion liefert in Form eines String-Arrays alle IMAP
     alert-Medlungen, die seit Beginn dieses Requests bzw. dem letzten
     Aufruf der Funktion aufgetreten sind. Durch den Aufruf der
     Funktion wird der alert-Stack gelscht, so da weitere Aufrufe
     zunchst bis zum Auftreten eines neuen alerts kein Ergebnis
     liefern.
    </para>
    <para>
     Die IMAP-Spezifikationen verlangen, da diese Meldungen an den
     Benutzer weitergegeben werden.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-status">
   <refnamediv>
    <refname>imap_status</refname>
    <refpurpose>
     Liefert ausgewhlte Statusinformationen zum angegebenen Postfach
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>object</type><methodname>imap_status</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
      <methodparam><type>int</type><parameter>options</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion liefert Statusinformationen zum mit
     <parameter>mailbox</parameter> angegebenen Postfach.
     Im der Bitmaske <parameter>options</parameter> knnen dabei
     folgende Funktionen ausgewhlt werden, die den Inhalt des
     zurckgegebenen Objekts beeinflussen:
     <itemizedlist>
      <listitem>
       <simpara>
        SA_MESSAGES - das Feld messages wird mit der Anzahl der
        enthaltenen Nachrichten gefllt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        SA_RECENT - das Feld recent wird mit der Anzahl der neuen
        Nachrichten gefllt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        SA_UNSEEN - das Feld unseen wird mit der Anzahl der noch nicht
        abgerufenen Nachrichten gefllt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        SA_UIDNEXT - das Feld uidnext wird mit der UID gefllt, die
        die nchste in diesem Postfach abgelegte Nachricht erhalten
        wird
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        SA_UIDVALIDITY - das Feld uidvalidity wird mit einer
        Konstanten gefllt, die sich immer dann verndern wird, wenn
        die UIDs der Nachrichten im Postfach sich vermutlich verndert
        haben
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        SA_ALL - es werden alle beschriebenen Felder gefllt
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
    <para>
     Status->flags wird ebenfalls gesetzt und enthlt eine Bitmaske
     aus den oben genannten Werten, die die tatschlich
     zurckgegebenen Informationen beschreibt.
    </para>
    <para>
     <example>
      <title><function>imap_status</function> Beispiel</title>
      <programlisting role="php">
$mbox = imap_open ("{your.imap.host}", "username", "password", OP_HALFOPEN)
      || die ("can't connect: " . imap_last_error());

$status = imap_status ($mbox, "{your.imap.host}INBOX", SA_ALL);
if($status) {
    print ("Messages:    " . $status->messages   ) . "&lt;br>\n";
    print ("Recent:      " . $status->recent     ) . "&lt;br>\n";
    print ("Unseen:      " . $status->unseen     ) . "&lt;br>\n";
    print ("UIDnext:     " . $status->uidnext    ) . "&lt;br>\n";
    print ("UIDvalidity: " . $status->uidvalidity) . "&lt;br>\n";
} else {
    print "imap_status failed: " . imap_lasterror() . "\n";
}
imap_close ($mbox);
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-utf7-decode">
   <refnamediv>
    <refname>imap_utf7_decode</refname>
    <refpurpose>
     Dekodiert einem String im modifizierten UTF-7 Format.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_utf7_decode</methodname>
      <methodparam><type>string</type><parameter>text</parameter></methodparam>
     </methodsynopsis>
    <para>
     Dekodiert den String <parameter>text</parameter> aus dem
     modifizierten UTF-7 Format in 8Bit-Text.
    </para>
    <para>
     Liefert den dekodierten Text oder &false;, wenn die Eingabe nicht
     gem modifiziertem UTF-7 formatiert war. Diese Funktion wird
     bentigt, um Postfachnamen zu decodieren, die internationale
     Sonderzeichen, wie z.B. unsere Umlaute, enthalten.
    </para>
    <para>
     (siehe <ulink url="&url.rfc;rfc2152.html">RFC2152</ulink>
     fr UTF-7 und <ulink url="&url.rfc;rfc2060.html">RFC2060</ulink>,
     Abschnitt 5.1.3 fr modifiziertes UTF-7)
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-utf7-encode">
   <refnamediv>
    <refname>imap_utf7_encode</refname>
    <refpurpose>
      Kodiert Text im modifizieren UTF-7 Format
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_utf7_encode</methodname>
      <methodparam><type>string</type><parameter>data</parameter></methodparam>
     </methodsynopsis>
    <para>
     Konvertiert den in <parameter>data</parameter> bergebenen Text
     in das modifizierte UTF-7 Format. Diese Funktion wird bentigt,
     um Postfachnamen darzustellen, die internationale Sonderzeichen,
     wie z.B. unsere Umlaute, enthalten.
    </para>
    <para>
     (siehe <ulink url="&url.rfc;rfc2152.html">RFC2152</ulink>
     fr UTF-7 und <ulink url="&url.rfc;rfc2060.html">RFC2060</ulink>,
     Abschnitt 5.1.3 fr modifiziertes UTF-7)
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-utf8">
   <refnamediv>
    <refname>imap_utf8</refname>
    <refpurpose>
      Konvertiert Text zu UTF8
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_utf8</methodname>
      <methodparam><type>string</type><parameter>text</parameter></methodparam>
     </methodsynopsis>
    <para>
     Konvertiert den bergebenen String in das UTF8-Format
     gem <ulink url="&url.rfc;rfc2044.html">RFC2044</ulink>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-fetch-overview">
   <refnamediv>
    <refname>imap_fetch_overview</refname>
    <refpurpose>
     Liefert einen Auszug aus den Header-Feldern von Nachrichten
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>imap_fetch_overview</methodname>
      <methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>sequence</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Diese Funktion liefert ausgewhlte Headerfelder der in
     <parameter>sequence</parameter> bergebenen Nachrichten und
     liefert sie in einem Array mit je einem Objekt pro Nachricht
     zurck. <parameter>sequence</parameter> enthlt eine Sequenz von
     Nachrichten-Indizes oder, bei gesetztem FT_UID in
     <parameter>flags</parameter>, von UIDs. Die einzelnen Objekte des
     zurckgegeben Arrays enthalten dabei folgende Informationen:
     <itemizedlist>
      <listitem>
       <simpara>
        subject - Betreff
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        from - Absender
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        date - Sendedatum
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        message_id - Message-ID
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        references - bezieht sich auf Message-ID
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        size - Gre in Byte
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        uid - UID der Nachricht im Postfach
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        msgno - Index der Nachricht im Postfach
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        recent - Flag gesetzt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        flagged - Flag gesetzt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        answered - Flag gesetzt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        deleted - Flag gesetzt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        seen - Flag gesetzt
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        draft - Flag gesetzt
       </simpara>
      </listitem>
     </itemizedlist>
    </para>
    <para>
     <example>
      <title><function>imap_fetch_overview</function> Beispiel</title>
      <programlisting role="php">
$mbox = imap_open ("{your.imap.host:143}", "username", "password")
    || die ("can't connect: " . imap_last_error());

$overview = imap_fetch_overview ($mbox, "2,4:6", 0);

if (is_array ($overview )) {
    reset ($overview);
    while (list ($key, $val) = each ($overview)) {
        print $val->msgno
            . " - " . $val->date
            . " - " . $val->subject
            . "\n";
    }
}

imap_close ($mbox);
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-mime-header-decode">
   <refnamediv>
    <refname>imap_mime_header_decode</refname>
    <refpurpose>Decode MIME header elements</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>array</type><methodname>imap_header_decode</methodname>
      <methodparam><type>string</type><parameter>text</parameter></methodparam>
     </methodsynopsis>
    <para>
                 <function>imap_mime_header_decode</function> decodiert MIME Headerfelder,
     die mehr als nur reinen ASCII-Text enthalten und gem
     <ulink url="&url.rfc;rfc2047.html">RFC2047</ulink> codiert wurden.
                 Die decodierten Teilstcke werden in einem Array von Objekten zurckgegeben,
     wobei jedes Objekt die Felder "text" fr den decodierten Teiltext und "charset"
     fr den zugehrigen Zeichensatz enthlt. Nichtcodierte Teile des Headerfeldes
     werden dabei durch den Wert "default" beschrieben.
    </para>
    <para>
                 Im folgenden Beispiel besteht das Headerfeld aus zwei Teilstcken,
     wobei das erste nach ISO-8859-1 codiert ist:
    </para>
    <para>
     <example>
      <title><function>imap_mime_header_decode</function> example</title>
      <programlisting role="php">
$text="=?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?= &lt;keld@dkuug.dk>";

$elements=imap_mime_header_decode($text);
for($i=0;$i&lt;count($elements);$i++) {
       echo "Charset: {$elements[$i]->charset}\n";
       echo "Text: {$elements[$i]->text}\n\n";
}

      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>


  <refentry id="function.imap-mail-compose">
   <refnamediv>
    <refname>imap_mail_compose</refname>
    <refpurpose>
     Erzeugt eine MIME-Nachricht aus gegebenen Header- und Body-Teilen
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_mail_compose</methodname>
      <methodparam><type>array</type><parameter>envelope</parameter></methodparam>
      <methodparam><type>array</type><parameter>body</parameter></methodparam>
     </methodsynopsis>
    <para>
<!--
envelope
 remail
 return_path
 date
 from
 reply_to
 to
 cc
 bcc
 message_id
body
 type
 encoding
 subtype
 id
 contents.data
 lines
 bytes
 md5
-->
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.imap-mail">
   <refnamediv>
    <refname>imap_mail</refname>
    <refpurpose>
     Versendet eine Email
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>imap_mail</methodname>
      <methodparam><type>string</type><parameter>to</parameter></methodparam>
      <methodparam><type>string</type><parameter>subject</parameter></methodparam>
      <methodparam><type>string</type><parameter>message</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>additional_headers</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>cc</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>bcc</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>rpath</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function is currently not available for PHP4 on WIN32.
    </para>
   </refsect1>
  </refentry>

 </reference>

<!-- 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:
-->