repo_zf1/documentation/manual/de/module_specs/Zend_Mail_Read.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 14978 -->
<!-- Reviewed: no -->
<sect1 id="zend.mail.read">
    <title>Lesen von Mail Nachrichten</title>

    <para>
        <classname>Zend_Mail</classname> kann Mail Nachrichten von verschiedenen lokalen oder entfernen Mailspeichern lesen.
        Alle von diesen haben die selbe Basis API für das Zählen und Holen von Nachrichten und einige von Ihnen
        implementieren zusätzliche Interfaces für nicht so übliche Features. Für eine Übersicht der Features der
        implementierten Speicher kann in die folgende Tabelle gesehen werden.
    </para>

    <table id="zend.mail.read.table-1">
        <title>Übersicht der Lesefeatures für Mails</title>
        <tgroup cols="5">
            <thead>
                <row>
                    <entry>Feature</entry>
                    <entry>Mbox</entry>
                    <entry>Maildir</entry>
                    <entry>Pop3</entry>
                    <entry>IMAP</entry>
                </row>
            </thead>
            <tbody>
                <row>
                    <entry>Speichertyp</entry>
                    <entry>lokal</entry>
                    <entry>lokal</entry>
                    <entry>entfernt</entry>
                    <entry>entfernt</entry>
                </row>
                <row>
                    <entry>Nachrichten holen</entry>
                    <entry>Yes</entry>
                    <entry>Yes</entry>
                    <entry>Yes</entry>
                    <entry>Yes</entry>
                </row>
                <row>
                    <entry>MIME-Part holen</entry>
                    <entry>emulated</entry>
                    <entry>emulated</entry>
                    <entry>emulated</entry>
                    <entry>emulated</entry>
                </row>
                <row>
                    <entry>Ordner</entry>
                    <entry>Yes </entry>
                    <entry>Yes</entry>
                    <entry>No</entry>
                    <entry>Yes</entry>
                </row>
                <row>
                    <entry>Erstellen von Nachrichten/Ordnern</entry>
                    <entry>No</entry>
                    <entry>todo</entry>
                    <entry>No</entry>
                    <entry>todo</entry>
                </row>
                <row>
                    <entry>Merker</entry>
                    <entry>No</entry>
                    <entry>Yes</entry>
                    <entry>No</entry>
                    <entry>Yes</entry>
                </row>
                <row>
                    <entry>Quote</entry>
                    <entry>No</entry>
                    <entry>Yes</entry>
                    <entry>No</entry>
                    <entry>No</entry>
                </row>
            </tbody>
        </tgroup>
    </table>

    <sect2 id="zend.mail.read-example">
        <title>Einfaches Beispiel für POP3</title>

        <programlisting role="php"><![CDATA[
$mail = new Zend_Mail_Storage_Pop3(array('host'     => 'localhost',
                                         'user'     => 'test',
                                         'password' => 'test'));

echo $mail->countMessages() . " Nachrichten gefunden\n";
foreach ($mail as $message) {
    echo "Mail von '{$message->from}': {$message->subject}\n";
}
]]>
        </programlisting>

    </sect2>
    <sect2 id="zend.mail.read-open-local">
        <title>Öffnen eines lokalen Speichers</title>

        <para>
            Mbox und Maildir sind zwei unterstützte Formate für lokale Mailspeicher, beide in Ihrem einfachsten
            Format.
        </para>
        <para>
            Wenn von einer Mbox Datei gelesen werden soll muß nur der Dateiname an den Konstruktor von
            <classname>Zend_Mail_Storage_Mbox</classname> übergeben werden:
        </para>

        <programlisting role="php"><![CDATA[
$mail = new Zend_Mail_Storage_Mbox(array('filename' =>
                                             '/home/test/mail/inbox'));
]]>
        </programlisting>

        <para>Maildir ist sehr einfach benötigt aber einen Verzeichnisnamen:</para>

        <programlisting role="php"><![CDATA[
$mail = new Zend_Mail_Storage_Maildir(array('dirname' =>
                                                '/home/test/mail/'));
]]>
        </programlisting>

        <para>Beide Konstruktoren werfen eine <classname>Zend_Mail_Exception</classname> Ausnahme wenn der Speicher nicht
        gelesen werden kann.</para>

    </sect2>
    <sect2 id="zend.mail.read-open-remote">
        <title>Öffnen eines entfernten Speichers</title>

        <para>
            Für entfernte Speicher werden die zwei populärsten Protokolle unterstützt: Pop3 und Imap. Beide
            benötigen mindestens einen Host und einen Benutzer für das Verbinden und das Login. Das Standardpasswort
            ist ein leerer String, der Standardport wie im RFC Protokoll definiert.
        </para>

        <programlisting role="php"><![CDATA[
// Verbinden mit Pop3
$mail = new Zend_Mail_Storage_Pop3(array('host'     => 'example.com',
                                         'user'     => 'test',
                                         'password' => 'test'));

// Verbinden mit Imap
$mail = new Zend_Mail_Storage_Imap(array('host'     => 'example.com',
                                         'user'     => 'test',
                                         'password' => 'test'));

// Beispiel für einen nicht Standardport
$mail = new Zend_Mail_Storage_Pop3(array('host'     => 'example.com',
                                         'port'     => 1120
                                         'user'     => 'test',
                                         'password' => 'test'));
]]>
        </programlisting>

        <para>
            Für beide Speicher werden SSL und TLS unterstützt. Wenn SSL verwendet wird, wird der Standardport laut
            RFC geändert.
        </para>

        <programlisting role="php"><![CDATA[
// Beispiel für Zend_Mail_Storage_Pop3
// funktioniert auch für Zend_Mail_Storage_Imap

// SSL mit einem unterschiedlichen Port verwenden
// (Standard ist 995 für Pop3 und 993 für Imap)
$mail = new Zend_Mail_Storage_Pop3(array('host'     => 'example.com',
                                         'user'     => 'test',
                                         'password' => 'test',
                                         'ssl'      => 'SSL'));

// Verwenden von TLS
$mail = new Zend_Mail_Storage_Pop3(array('host'     => 'example.com',
                                         'user'     => 'test',
                                         'password' => 'test',
                                         'ssl'      => 'TLS'));
]]>
        </programlisting>

        <para>
            Beide Konstruktoren können eine <classname>Zend_Mail_Exception</classname> oder
            <classname>Zend_Mail_Protocol_Exception</classname> werfen (erweitert <classname>Zend_Mail_Exception</classname>),
            abhängig vom Typ des Fehlers.
        </para>

    </sect2>
    <sect2 id="zend.mail.read-fetching">
        <title>Nachrichten holen und einfache Methoden</title>

        <para>
            Wenn der Speicher einmal geöffnet wurde können Nachrichten geholt werden. Man benötigt die
            Nachrichtennummer, welche ein Zähler ist der mit 1 für die erste Nachricht beginnt. Um die Nachrichten
            zu holen muß die Methode <code>getMessage()</code> verwendet werden:
        </para>

        <programlisting role="php"><![CDATA[
$message = $mail->getMessage($messageNum);
]]>
        </programlisting>

        <para>
            Zugriff über Arrays ist auch möglich, unterstützt aber nicht jeden zusätzlichen Parameter der zu
            <code>getMessage()</code> hinzugefügt werden könnte:
        </para>

        <programlisting role="php"><![CDATA[
$message = $mail[$messageNum];
]]>
        </programlisting>

        <para>Um über alle Nachrichten zu iterieren wurde das Iterator Interface implementiert:</para>

        <programlisting role="php"><![CDATA[
foreach ($mail as $messageNum => $message) {
    // mach was ...
}
]]>
        </programlisting>

        <para>
            Um die Nachrichten im Speicher zu zählen kann entweder die Methode <code>countMessages()</code> oder
            der Zugriff auf Arrays verwendet werden:
        </para>

        <programlisting role="php"><![CDATA[
// Methode
$maxMessage = $mail->countMessages();

// Array Zugriff
$maxMessage = count($mail);
]]>
        </programlisting>

        <para>Um eine Mail zu entfernen kann die Methode <code>removeMessage()</code> oder auch der Array Zugriff
        verwendet werden:</para>

        <programlisting role="php"><![CDATA[
// Methode
$mail->removeMessage($messageNum);

// Array Zugriff
unset($mail[$messageNum]);
]]>
        </programlisting>

    </sect2>
    <sect2 id="zend.mail.read-message">
        <title>Arbeiten mit Nachrichten</title>

        <para>Nachdem die Nachrichten mit <code>getMessage()</code> geholt wurden, wird man die Kopfzeilen, den
        Inhalt oder einzelne Teile einer Mehrteiligen Nachricht holen wollen. Auf alle Kopfzeilen kann über die
        Eigenschaften oder die Methode <code>getHeader()</code>, wenn man mehr Kontrolle oder ungewöhnliche
        Kopfzeilen hat, zugegriffen werden. Die Kopfzeilen sind intern kleingeschrieben, weswegen die Groß- und
        Kleinschreibung der Kopfzeilen in der Mail Nachricht egal ist. Kopfzeilen mit einem Bindestrich können auch
        in camel-case Schreibweise geschrieben werden. Wenn für beide Schreibweisen kein Header gefunden wird,
        wird eine Ausnahme geworfen. Um das zu verhindern kann die <code>headerExists()</code> Methode verwendet
        werden um die Existenz einer Kopfzeile zu prüfen.</para>

        <programlisting role="php"><![CDATA[
// Nachrichten Objekt holen
$message = $mail->getMessage(1);

// Betreff der Nachricht holen
echo $message->subject . "\n";

// Inhalts-Typ der Kopfzeile holen
$type = $message->contentType;

// Prüfen ob CC gesetzt ist:
if( isset($message->cc) ) { // oder $message->headerExists('cc');
    $cc = $message->cc;
}
]]>
        </programlisting>

        <para>Wenn mehrere Kopfzeilen mit dem selben Namen vorhanden sind z.B. die empfangenen Kopfzeilen
        kann es gewünscht sein diese als Array statt als String zu haben, was mit der <code>getHeader()</code>
        Methode möglich ist.</para>

        <programlisting role="php"><![CDATA[
// Kopfzeilen als Eigenschaft holen - das Ergebnis ist immer ein String,
// mit Zeilenumbruch zwischen den einzelnen Vorkommen in der Nachricht
$received = $message->received;

// Das gleiche über die getHeader() Methode
$received = $message->getHeader('received', 'string');

// Besser ein Array mit einem einzelnen Eintrag für jedes Vorkommen
$received = $message->getHeader('received', 'array');
foreach ($received as $line) {
    // irgendwas tun
}

// Wenn kein Format definiert wurde wird die interne Repräsentation
// ausgegeben (String für einzelne Kopfzeilen, Array für mehrfache)
$received = $message->getHeader('received');
if (is_string($received)) {
    // Nur eine empfangene Kopfzeile in der Nachricht gefunden
}
]]>
        </programlisting>

        <para>Die Methode <code>getHeaders()</code> gibt alle Kopfzeilen als Array mit den kleingeschriebenen Namen
        als Schlüssel und den Wert als Array für mehrere Kopfzeilen oder als String für einzelne Kopfzeilen.</para>

        <programlisting role="php"><![CDATA[
// Alle Kopfzeilen wegschmeißen
foreach ($message->getHeaders() as $name => $value) {
    if (is_string($value)) {
        echo "$name: $value\n";
        continue;
    }
    foreach ($value as $entry) {
        echo "$name: $entry\n";
    }
}
]]>
        </programlisting>

        <para>Wenn keine Nachricht aus mehreren Teilen vorlieg kann der Inhalt sehr einfach über
        <code>getContent()</code> geholt werden. Anders als die Kopfzeilen wird der Inhalt nur geholt wenn dies
        benötigt wird (wie spätes-holen).</para>

        <programlisting role="php"><![CDATA[
// Inhalt der Nachricht für HTML ausgeben
echo '<pre>';
echo $message->getContent();
echo '</pre>';
]]>
        </programlisting>

        <para>Die Prüfung auf mehrteilige Nachrichten wird in der Methode <code>isMultipart()</code> gemacht.
        Wenn eine mehrteilige Nachricht vorliegt kann eine Instanz von <classname>Zend_Mail_Part</classname> mit der
        Methode <code>getPart()</code> geholt werden. <classname>Zend_Mail_Part</classname> ist die Basisklasse von
        <classname>Zend_Mail_Message</classname>, sie hat also die gleichen Methoden: <code>getHeader()</code>,
        <code>getHeaders()</code>, <code>getContent()</code>, <code>getPart()</code>, <code>isMultipart</code>
        und die Eigenschaften der Kopfzeilen.</para>

        <programlisting role="php"><![CDATA[
// Hole den ersten nicht geteilten Teil
$part = $message;
while ($part->isMultipart()) {
    $part = $message->getPart(1);
}
echo 'Der Typ des Teils ist ' . strtok($part->contentType, ';') . "\n";
echo "Inhalt:\n";
echo $part->getContent();
]]>
        </programlisting>

        <para><classname>Zend_Mail_Part</classname> implementiert auch den <code>RecursiveIterator</code>, welcher es sehr einfach macht alle Teile
        zu durchsuchen. Und für die einfache Ausgabe wurde auch die magische Methode <code>__toString()</code> implementiert,
        welche den Inhalt zurückgibt.</para>

        <programlisting role="php"><![CDATA[
// Gibt den ersten text/plain Teil aus
$foundPart = null;
foreach (new RecursiveIteratorIterator($mail->getMessage(1)) as $part) {
    try {
        if (strtok($part->contentType, ';') == 'text/plain') {
            $foundPart = $part;
            break;
        }
    } catch (Zend_Mail_Exception $e) {
        // ignorieren
    }
}
if (!$foundPart) {
    echo 'kein reiner Text-Teil gefunden';
} else {
    echo "Reiner Text-Teil: \n" . $foundPart;
}
]]>
        </programlisting>

    </sect2>
    <sect2 id="zend.mail.read-flags">
        <title>Auf Flags prüfen</title>

        <para>Maildir und IMAP unterstützen das Speichern von Flags. Die Klasse <classname>Zend_Mail_Storage</classname> hat Konstanten für
        alle bekannten maildir und IMAP System Flags, welche <classname>Zend_Mail_Storage::FLAG_&lt;flagname&gt;</classname>
        heißen. Um auf Flags zu prüfen hat <classname>Zend_Mail_Message</classname> eine Methode die <code>hasFlag()</code>
        heißt. Mit <code>getFlags()</code> erhält man alle gesetzten Flags.</para>

        <programlisting role="php"><![CDATA[
// Finde ungelesene Nachrichten
echo "Ungelesene Nachrichten:\n";
foreach ($mail as $message) {
    if ($message->hasFlag(Zend_Mail_Storage::FLAG_SEEN)) {
        continue;
    }
    // Vorherige/Neue Nachrichten markieren
    if ($message->hasFlag(Zend_Mail_Storage::FLAG_RECENT)) {
        echo '! ';
    } else {
        echo '  ';
    }
    echo $message->subject . "\n";
}


// Prüfen auf bekannte Flags
$flags = $message->getFlags();
echo "Nachricht wurde markiert als: ";
foreach ($flags as $flag) {
    switch ($flag) {
        case Zend_Mail_Storage::FLAG_ANSWERED:
            echo 'Beantwortet ';
            break;
        case Zend_Mail_Storage::FLAG_FLAGGED:
            echo 'Markiert ';
            break;

        // ...
        // Auf andere Flags prüfen
        // ...

        default:
            echo $flag . '(unbekanntes Flag) ';
    }
}
]]>
        </programlisting>

        <para>Da IMAP Benutzern oder auch Clients selbstdefinierte Flags erlaubt, können auch Flags empfangen werden
        die keine Konstante in <classname>Zend_Mail_Storage</classname> haben. Stattdessen werden sie als String zurückgegeben
        und können auf dem selben Weg mit <code>hasFlag()</code> geprüft werden.</para>

        <programlisting role="php"><![CDATA[
// Nachricht auf vom Client definierte Flags $IsSpam, $SpamTested prüfen
if (!$message->hasFlag('$SpamTested')) {
    echo 'Die Nachricht wurde nicht auf Spam geprüft';
} else if ($message->hasFlag('$IsSpam')) {
    echo 'Diese Nachricht ist Spam';
} else {
    echo 'Diese Nachricht ist Speck';
}
]]>
        </programlisting>

    </sect2>
    <sect2 id="zend.mail.read-folders">
        <title>Verwenden von Ordnern</title>

        <para>
            Alle Speicher, ausser Pop3, unterstützen Ordner, welche Mailboxen genannt werden. Das Interface das von
            allen Speichern implementiert wurde und Ordner unterstützt heißt
            <classname>Zend_Mail_Storage_Folder_Interface</classname>. Alle diese Klassen besitzen auch einen zusätzlichen
            optionalen Parameter welcher <code>folder</code> heißt, was der ausgewählt Ordner nach dem Login, im Konstruktor ist.
        </para>
        <para>
            Für den lokalen Speicher müssen die eigenen Klassen <classname>Zend_Mail_Storage_Folder_Mbox</classname> oder
            <classname>Zend_Mail_Storage_Folder_Maildir</classname> genannt verwendet werden. Beide benötigen einen Parameter
            der <code>dirname</code> heißt mit dem Namen des Basisverzeichnisses. Das Format für Maildir ist wie in Maildir++
            definiert (mit einem Punkt als Standardbegrenzer), Mbox ist eine Verzeichnisstruktur mit Mbox Dateien.
            Wenn im Mbox Basisverzeichnis keine Mbox Datei vorhanden ist die INBOX heißt, muß ein anderer Ordner
            im Konstruktor gesetzt werden.
        </para>
        <para>
            <classname>Zend_Mail_Storage_Imap</classname> unterstützt Ordner schon standardmäßig. Beispiele für das Öffnen
            solcher Speicher:
        </para>

        <programlisting role="php"><![CDATA[
// MBox mit Ordnern
$mail = new Zend_Mail_Storage_Folder_Mbox(array('dirname' =>
                                                    '/home/test/mail/'));

// MBox mit standard Ordner der nicht INBOX heißt, funktioniert auch
// mit Zend_Mail_Storage_Folder_Maildir und Zend_Mail_Storage_Imap
$mail = new Zend_Mail_Storage_Folder_Mbox(array('dirname' =>
                                                    '/home/test/mail/',
                                                'folder'  =>
                                                    'Archive'));

// Maildir mit Ordnern
$mail = new Zend_Mail_Storage_Folder_Maildir(array('dirname' =>
                                                       '/home/test/mail/'));

// Maildir mir Doppelpunkt als Begrenzung, wie in Maildir++ empfohlen
$mail = new Zend_Mail_Storage_Folder_Maildir(array('dirname' =>
                                                       '/home/test/mail/',
                                                   'delim'   => ':'));

// IMAP ist genauso mit und ohne Ordner
$mail = new Zend_Mail_Storage_Imap(array('host'     => 'example.com',
                                         'user'     => 'test',
                                         'password' => 'test'));
]]>
        </programlisting>

        <para>
            Mit der Methode getFolders($root = null) kann die Verzeichnisstruktur beginnend mit dem
            Basisverzeichnis oder einem angegebenen Ordner ausgegeben werden. Sie wird als Instanz von
            <classname>Zend_Mail_Storage_Folder</classname> zurückgegeben, welche <code>RecursiveIterator</code> implementiert
            und alle Kinder sind genauso Instanzen von <classname>Zend_Mail_Storage_Folder</classname>. Jede dieser
            Instanzenhat einen lokalen und einen globalen Namen der durch die Methoden <code>getLocalName()</code>
            und <code>getGlobalName()</code> zurückgegeben wird. Der globale Name ist der absolute Name des
            Basisordners (inklusive Begrenzer), der lokale Name ist der Name im Elternordner.
        </para>

        <table id="zend.mail.read-folders.table-1">
            <title>Namen für Nachrichtenordner</title>
            <tgroup cols="2">
                <thead>
                    <row>
                        <entry>Globaler Name</entry>
                        <entry>Lokaler Name</entry>
                    </row>
                </thead>
                <tbody>
                    <row>
                        <entry>/INBOX</entry>
                        <entry>INBOX</entry>
                    </row>
                    <row>
                        <entry>/Archive/2005</entry>
                        <entry>2005</entry>
                    </row>
                    <row>
                        <entry>List.ZF.General</entry>
                        <entry>General</entry>
                    </row>
                </tbody>
            </tgroup>
        </table>

        <para>
            Wenn der Iterator verwendet wird ist der lokale Name der Schlüssel des aktuellen Elements. Der globale
            Name wird auch durch die magische Methode <code>__toString()</code> zurückgegeben. Gleiche Ordner können
            nicht ausgewählt werden, was bedeutet das Sie keine Nachrichten speichern können und die Auswahl von
            Ergebnisses führt zu einem Fehler. Das kann mit der Methode <code>isSelectable()</code> geprüft werden.
            Es ist also sehr einfach den ganzen Baum in einer Ansicht auszugeben:
        </para>

        <programlisting role="php"><![CDATA[
$folders = new RecursiveIteratorIterator($this->mail->getFolders(),
                                         RecursiveIteratorIterator::SELF_FIRST);
echo '<select name="folder">';
foreach ($folders as $localName => $folder) {
    $localName = str_pad('', $folders->getDepth(), '-', STR_PAD_LEFT) .
                 $localName;
    echo '<option';
    if (!$folder->isSelectable()) {
        echo ' disabled="disabled"';
    }
    echo ' value="' . htmlspecialchars($folder) . '">'
        . htmlspecialchars($localName) . '</option>';
}
echo '</select>';
]]>
        </programlisting>

        <para>
            Der aktuell ausgewählte Ordner wird durch die Methode <code>getSelectedFolder()</code> zurückgegeben.
            Das Ändern von Ordnern wird mit der Methode <code>selectFolder()</code> durchgeführt, welche den globalen
            Namen als Parameter benötigt. Wenn das Schreiben von Begrenzern vermieden werden soll, können auch die
            Eigenschaften einer <classname>Zend_Mail_Storage_Folder</classname> Instanz verwendet werden:
        </para>

        <programlisting role="php"><![CDATA[
// Abhängig vom Mail Speicher und seinen Einstellungen
// $rootFolder->Archive->2005 ist das gleiche wie:
//   /Archive/2005
//  Archive:2005
//  INBOX.Archive.2005
//  ...
$folder = $mail->getFolders()->Archive->2005;
echo 'Der letzte Ordner war '
   . $mail->getSelectedFolder()
   . "neuer Ordner ist $folder\n";
$mail->selectFolder($folder);
]]>
        </programlisting>

    </sect2>
    <sect2 id="zend.mail.read-advanced">
        <title>Forgeschrittene Verwendung</title>

        <sect3 id="zend.mail.read-advanced.noop">
            <title>NOOP verwenden</title>

            <para>
                Wenn ein entfernter Speicher verwendet werden soll und einige lange Aufgaben anstehen kann es
                notwendig sein die Verbindung über noop am Leben zu halten:
            </para>

            <programlisting role="php"><![CDATA[
foreach ($mail as $message) {

    // einige Berechnungen ...

    $mail->noop(); // am Leben halten

    // irgendwas anderes tun ...

    $mail->noop(); // am Leben halten
}
]]>
            </programlisting>

        </sect3>
        <sect3 id="zend.mail.read-advanced.caching">
            <title>Instanzen cachen</title>

            <para>
            <classname>Zend_Mail_Storage_Mbox</classname>, <classname>Zend_Mail_Storage_Folder_Mbox</classname>,
            <classname>Zend_Mail_Storage_Maildir</classname> und <classname>Zend_Mail_Storage_Folder_Maildir</classname> implementieren
            die magischen Methoden <code>__sleep()</code> und <code>__wakeup()</code> was bedeutet das Sie
            serialisierbar sind. Das vermeidet das Parsen von Dateien oder Verzeichnisbäumen mehr als einmal. Der
            Nachteil ist das der Mbox oder Maildir Speicher sich nicht Ändern sollte. Einige einfache Prüfungen
            werden durchgeführt, wie das neuparsen der aktuellen Mbox Datei wenn sich der Bearbeitungszeitpunkt
            ändert oder das neuparsen der Verzeichnisstruktur wenn ein Ordner entfernt wurde (was immer noch zu einem
            Fehler führt, es kan aber im Nachhinein ein anderer Ordner gesucht werden). Es ist besser etwas wie eine
            Signaldatei für Änderungen zu haben, und diese zu Prüfen bevor eine gecachete Instanz verwendet wird.
            </para>

            <programlisting role="php"><![CDATA[
// Es wird kein spezieller Cache Handler/Klasse verwendet
// Code ändern damit er zum Cache Handler passt
$signal_file = '/home/test/.mail.last_change';
$mbox_basedir = '/home/test/mail/';
$cache_id = 'Beispiel Nachrichten Cache ' . $mbox_basedir . $signal_file;

$cache = new Your_Cache_Class();
if (!$cache->isCached($cache_id) ||
    filemtime($signal_file) > $cache->getMTime($cache_id)) {
    $mail = new Zend_Mail_Storage_Folder_Pop3(array('dirname' =>
                                                        $mbox_basedir));
} else {
    $mail = $cache->get($cache_id);
}

// irgendwas machen ...

$cache->set($cache_id, $mail);
]]>
            </programlisting>

        </sect3>
        <sect3 id="zend.mail.read-advanced.extending">
            <title>Prokoll Klassen erweitern</title>

            <para>
                Entfernte Speicher verwenden zwei Klassen: <classname>Zend_Mail_Storage_&lt;Name&gt;</classname> und
                <classname>Zend_Mail_Protocol_&lt;Name&gt;</classname>. Die Protkoll Klasse übersetzt die Protokollbefehle
                und antwortet von und zu PHP, wie Methoden für die Befehle oder Variablen mit verschiedenen
                Strukturen für Daten. Die andere/Haupt Klasse implementiert das Stadard Interface.
            </para>

            <para>
                Wenn zusätzliche Protokoll Features benötigt werden kann die Protokoll Klasse erweitert werden und
                diese im Konstruktor der Basisklasse verwendet werden. Als Beispiel nehmen wir an das verschiedene
                Ports abgeklopft werden bevor auf POP3 verbunden werden kann.
            </para>

            <programlisting role="php"><![CDATA[
class Example_Mail_Exception extends Zend_Mail_Exception
{
}

class Example_Mail_Protocol_Exception extends Zend_Mail_Protocol_Exception
{
}

class Example_Mail_Protocol_Pop3_Knock extends Zend_Mail_Protocol_Pop3
{
    private $host, $port;

    public function __construct($host, $port = null)
    {
        // kein automatisches Verbinden in dieser Klasse
        $this->host = $host;
        $this->port = $port;
    }

    public function knock($port)
    {
        $sock = @fsockopen($this->host, $port);
        if ($sock) {
            fclose($sock);
        }
    }

    public function connect($host = null, $port = null, $ssl = false)
    {
        if ($host === null) {
            $host = $this->host;
        }
        if ($port === null) {
            $port = $this->port;
        }
        parent::connect($host, $port);
    }
}

class Example_Mail_Pop3_Knock extends Zend_Mail_Storage_Pop3
{
    public function __construct(array $params)
    {
        // ... Parameter hier prüfen! ...
        $protocol = new Example_Mail_Protocol_Pop3_Knock($params['host']);

        // Spezial "Ding" hier machen
        foreach ((array)$params['knock_ports'] as $port) {
            $protocol->knock($port);
        }

        // den richtigen Status erhalten
        $protocol->connect($params['host'], $params['port']);
        $protocol->login($params['user'], $params['password']);

        // Eltern initialisieren
        parent::__construct($protocol);
    }
}

$mail = new Example_Mail_Pop3_Knock(array('host'        => 'localhost',
                                          'user'        => 'test',
                                          'password'    => 'test',
                                          'knock_ports' =>
                                              array(1101, 1105, 1111)));
]]>
            </programlisting>

            <para>
                Wie gesehen werden kann wird angenommen das man immer verbunden, eingeloggt und, wenn es
                unterstützt wird, ein Ordner im Konstruktor der Basisklasse ausgewählt ist. Das bedeutet, wenn eine
                eigene Protokollklasse verwendet wird muß immer sichergestellt werden das das durchgeführt wird, da
                sonst die nächste Methode fehlschlagen wird wenn der Server das im aktuellen Status nicht
                zuläßt.
            </para>

        </sect3>
        <sect3 id="zend.mail.read-advanced.quota">
            <title>Quote verwenden (seit 1.5)</title>

            <para>
                <classname>Zend_Mail_Storage_Writable_Maildir</classname> bietet Unterstützung für Maildir++
                Quoten. Diese sind standardmäßig ausgeschaltet, aber es ist möglich Sie manuell zu
                verwenden, wenn automatische Checks nicht gewünscht sind (das bedeutet
                <code>appendMessage()</code>, <code>removeMessage()</code> und
                <code>copyMessage()</code> führen keine Checks durch und fügen keinen Eintrag zur
                maildirsize Datei hinzu). Wenn aktiviert, wird eine Ausnahme geworfen wenn versucht
                wird in maildir zu schreiben wenn es bereits voll ist und die Quote überschritten
                wurde.
            </para>

            <para>
                Es gibt drei Methoden die für Quoten verwendet werden: <code>getQuota()</code>,
                <code>setQuota()</code> und <code>checkQuota()</code>:
            </para>

            <programlisting role="php"><![CDATA[
$mail = new Zend_Mail_Storage_Writable_Maildir(array('dirname' =>
                                                   '/home/test/mail/'));
$mail->setQuota(true); // true zum einschalten, false zum ausschalten
echo 'Quotenprüfung ist jetzt ', $mail->getQuota() ? 'eingeschaltet'
                                                   : 'ausgeschaltet', "\n";
// Quotenprüfung kann verwendet werden
// selbst wenn die Quotenprüfung ausgeschaltet ist
echo 'Sie sind ', $mail->checkQuota() ? 'über der Quote'
                                      : 'nicht über der Quote', "\n";
]]>
            </programlisting>

            <para>
                <code>checkQuota()</code> kann eine viel detailiertere Antwort zurückgeben:
            </para>

            <programlisting role="php"><![CDATA[
$quota = $mail->checkQuota(true);
echo 'Sie sind ', $quota['over_quota'] ? 'über der Quote'
                                       : 'nicht über der Quote', "\n";
echo 'Sie haben ',
    $quota['count'],
    ' von ',
    $quota['quota']['count'],
    ' Nachrichten und verwenden ';
echo $quota['size'], ' von ', $quota['quota']['size'], ' Oktets';
]]>
            </programlisting>

            <para>
                Wenn man eigene Quoten spezifizieren will statt die bereits in der maildirsize
                Datei spezifizierte zu verwenden kann das mit <code>setQuota()</code> getan werden:
            </para>

            <programlisting role="php"><![CDATA[
// message count and octet size supported, order does matter
$quota = $mail->setQuota(array('size' => 10000, 'count' => 100));
]]>
            </programlisting>

            <para>
                Wenn eigene Quotenchecks hinzugefügt werden sollen können einzelne Buchstaben als
                Schlüssel verwendet werden und Sie werden reserviert (aber logischerweise nicht
                geprüft). Es ist auch möglich <classname>Zend_Mail_Storage_Writable_Maildir</classname> zu
                erweitern um eigene Quoten zu definieren wenn die maildirsize Datei fehlt (was in
                Maildir++ vorkommen kann):
            </para>

            <programlisting role="php"><![CDATA[
class Example_Mail_Storage_Maildir extends Zend_Mail_Storage_Writable_Maildir {
    // getQuota wird mit $fromStorage = true durch die Quotenprüfung aufgerufen
    public function getQuota($fromStorage = false) {
        try {
            return parent::getQuota($fromStorage);
        } catch (Zend_Mail_Storage_Exception $e) {
            if (!$fromStorage) {
                // unbekannter Fehler:
                throw $e;
            }
            // Die maildirsize Datei muß fehlen

            list($count, $size) = get_quota_from_somewhere_else();
            return array('count' => $count, 'size' => $size);
        }
    }
}
]]>
            </programlisting>

        </sect3>
    </sect2>
</sect1>
<!--
vim:se ts=4 sw=4 et:
-->