<?php
$mail = new Zend_Mail_Storage_Pop3(array('host'     => 'localhost',
                                         'user'     => 'test',
                                         'password' => 'test'));

echo $mail->countMessages() . " messages trouvés\n";
foreach ($mail as $message) {
    echo "Mail from '{$message->from}': {$message->subject}\n";
}
?>

Mbox et Maildir sont les deux formats supportés pour le stockage local des emails, tous les deux dans leurs formats le plus simple.

Si vous voulez lire un fichier Mbox, vous devez juste donner le nom du fichier au constructeur de Zend_Mail_Storage_Mbox:

<?php
$mail = new Zend_Mail_Storage_Mbox(array('filename' => '/home/test/mail/inbox'));
?>

Maildir est très similaire mais nécessite un nom de dossier :

<?php
$mail = new Zend_Mail_Storage_Maildir(array('dirname' => '/home/test/mail/'));
?>

Ces deux constructeurs lèvent une exception Zend_Mail_Exception si le stockage ne peut pas être lu.

Pour les stockages distants les deux protocoles les plus populaires sont supportés : Pop3 et Imap. Les deux nécessitent au moins un hôte et un utilisateur pour se connecter et s'identifier. Le mot de passe par défaut est une chaîne vide et le port par défaut celui donné dans la RFC du protocole.

<?php
// connection à Pop3
$mail = new Zend_Mail_Storage_Pop3(array('host'     => 'exemple.com'
                                         'user'     => 'test',
                                         'password' => 'test'));

// connection à Imap
$mail = new Zend_Mail_Storage_Imap(array('host'     => 'exemple.com'
                                         'user'     => 'test',
                                         'password' => 'test'));

// exemple à un port non standard
$mail = new Zend_Mail_Storage_Pop3(array('host'     => 'exemple.com',
                                         'port'     => 1120
                                         'user'     => 'test',
                                         'password' => 'test'));
?>

Pour ces deux stockages SSL et TLS sont supportés. Si vous utilisez SSL le port par défaut change comme indiqué dans la RFC.

<?php
// exemples pour Zend_Mail_Storage_Pop3, identique à Zend_Mail_Storage_Imap

// utiliser SSL avec un port différent (par défaut 995 pour Pop3 et 993 pour Imap)
$mail = new Zend_Mail_Storage_Pop3(array('host'     => 'exemple.com'
                                         'user'     => 'test',
                                         'password' => 'test',
                                         'ssl'      => 'SSL'));

// utiliser TLS
$mail = new Zend_Mail_Storage_Pop3(array('host'     => 'exemple.com'
                                         'user'     => 'test',
                                         'password' => 'test',
                                         'ssl'      => 'TLS'));
?>

Les deux constructeurs peuvent lever une exception Zend_Mail_Exception ou Zend_Mail_Protocol_Exception(étendant Zend_Mail_Exception), en fonction du type de l'erreur.

Dès que vous avez ouvert l'accès, les messages peuvent être extraits. Vous devez fournir un numéro de message, qui est un compteur qui démarre à 1 pour le premier message. Pour extaire le message vous utilisez la méthode getMessage() :

<?php
$message = $mail->getMessage($numeroDeMessage);
?>

L'accès sous forme de tableau est aussi supporté, mais ne supporte pas des paramètres additionnels qui aurait pu être ajouté à getMessage(). Tant que vous n'en n'avez pas besoin et que vous pouvez vivre avec les valeurs par défaut, vous pouvez utiliser :

<?php
$message = $mail[$numeroDeMessage];
?>

Pour itérer tous les messages, l'interface Iterator est implémentée :

<?php
foreach ($mail as $numeroDeMessage => $message) {
    // faire qqch ...
}
?>

Pour compter les messages dans le stockage, vous pouvez soit utiliser la méthode countMessages() ou utiliser l'accès de type tableau :

<?php
// par méthode
$maxMessage = $mail->countMessages();

// type tableau
$maxMessage = count($mail);
?>

Pour supprimer un mail vous pouvez utiliser la méthode removeMessage() ou l'accès de type tableau :

<?php
// méthode
$mail->removeMessage($numeroDeMessage);

// type tableau
unset($mail[$messageNum]);
?>

Après avoir extrait les messages avec getMessage() vous voulez extraire les entêtes, le contenu ou une partie d'un message multipart. Tous les entêtes peuvent être accédées via les propriétés ou la méthode getHeader() si vous voulez plus de contrôle ou avoir accès à des entêtes peu communs. Les noms des entêtes gérés en interne avec une casse minuscule, ainsi la casse du nom de l'enête importe peu. En outre les enêtes avec un underscore peuvent être écrit avec la notation Camel.

<?php
// récupérer l'objet message
$message = $mail->getMessage(1);

// afficher le sujet du message
echo $message->subject . "\n";

// récupérer l'entête content-type
$type = $message->contentType;
?>

Si vous avez plusieurs entêtes avec le même nom, par exemple les entêtes "Received", vous pourriez les vouloir sous la forme d'un tableau (array) plutôt qu'en tant que chaîne. Ceci est possible avec la méthode getHeader().

<?php
// récupérer l'entête comme une propriété - le résultat est toujours une chaîne, avec de nouvelles lignes entre chaque occurence dans le message
$received = $message->received;

// la même chose avec la méthode getHeader()
$received = $message->getHeader('received', 'string');

// ou mieux un tableau avec une entrée pour chaque occurence
$received = $message->getHeader('received', 'array');
foreach ($received as $line) {
    // faire qqch
}

// si vous ne définissez pas de format vous récupérerez la représentation interne (chaîne pour entêtes uniques, tableau pour entêtes multiples
$received = $message->getHeader('received');
if (is_string($received)) {
    // seulement un entête received trouvé dans le message
}
?>

La méthode getHeaders() retourne tous les headers sous forme de tableau avec des clés en miniscules et des valeurs en tant que tableau pour des entêtes multiples ou une chaîne pour des entêtes uniques.

<?php
// récupère tous les entêtes
foreach ($message->getHeaders as $name => $value) {
    if (is_string($value)) {
        echo "$name: $value\n";
        continue;
    }
    foreach ($value as $entry) {
        echo "$name: $entry\n";
    }
}
?>

Si vous n'avez pas de message de type multipart, extraire le contenu est facilité avec getContent(). A la différence des entêtes, le contenu est seulement extrait en cas de besoin (alias late-fetch).

<?php
// affiche le contenu du message
echo '<pre>';
echo $message->getContent();
echo '</pre>';
?>

Vérifier si un message est de type multipart est réalisé avec la méthode isMultipart(). Si vous avez un message de type multipart vous pouvez récupérer une instance de Zend_Mail_Part avec la méthode getPart(). Zend_Mail_Part est la classe de base de Zend_Mail_Message, donc vous avez les mêmes méthodes : getHeader(), getHeaders(), getContent(), getPart(), isMultipart et les propriétés pour les entêtes.

<?php
// récupérer la première partie non-multipart
$part = $message;
while ($part->isMultipart()) {
    $part = $message->getPart(1);
}
echo 'Le type de cette partie est ' . strtok($part->contentType, ';') . "\n";
echo "Contenu :\n";
echo $part->getContent();
?>

Zend_Mail_Part implémente aussi RecursiveIterator, qui rend facile le scan de toutes les parties. Et pour un affichage facile, il implémente de plus la méthode magique __toString() qui retourne le contenu.

<?php
// affiche la première partie de type text/plain=
$foundPart = null;
foreach (RecursiveIteratorIterator($mail->getMessage(1)) as $part) {
    try {
        if (strtok($part->contentType, ';') == 'text/plain') {
            $foundPart = $part;
            break;
        }
    } catch (Zend_Mail_Exception $e) {
        // ignore
    }
}
if (!$foundPart) {
    echo 'Aucune partie "plain text" trouvés';
} else {
    echo "Partie \"plain text\" : \n" . $foundPart;
}
?>

Maildir et IMAP supporte l'enregistrement de drapeaux. La classe Zend_Mail_Storage possède des constantes pour tous les drapeaux maildir et IMAP connus, nommés Zend_Mail_Storage::FLAG_<nomdudrapeau>. Pour vérifier les drapeaux Zend_Mail_Message possède une méthode hasFlag(). Avec getFlags() vous récupérez tous les drapeaux existants.

<?php
// trouvé les messages non lus
echo "Emails non lus :\n";
foreach ($mail as $message) {
    if ($message->hasFlag(Zend_Mail_Storage::FLAG_SEEN)) {
        continue;
    }
    // marque les emails récents/nouveaux
    if ($message->hasFlag(Zend_Mail_Storage::FLAG_RECENT)) {
        echo '! ';
    } else {
        echo '  ';
    }
    echo $message->subject . "\n";
}


// vérifie les drapeaux connus
$flags = $message->getFlags();
echo "Le message est marqué comme : ";
foreach ($flags as $flag) {
    switch ($flag) {
        case Zend_Mail_Storage::FLAG_ANSWERED:
            echo 'Réponse ';
            break;
        case Zend_Mail_Storage::FLAG_FLAGGED:
            echo 'Marqués ';
            break;

        // ...
        // vérifie d'autres drapeaux
        // ...

        default:
            echo $flag . '(drapeau inconnu) ';
    }
}
?>

Comme IMAP autorise les drapeaux définis par client ou l'utilisateur, vous pouvez obtenir ces drapeaux même s'ils n'ont pas de constante dans Zend_Mail_Storage. Au lieu de cela ils sont retournés comme une chaîne et peuvent être vérifiés de la même manière avec hasFlag().

<?php
// Vérifie le message avec les drapeaux $EstUnSpam, $SpamTeste
if (!$message->hasFlag('$SpamTeste')) {
    echo 'ce message n\'est pas considéré comme un spam';
} else if ($message->hasFlag('$EstUnSpam')) {
    echo 'ce message est un spam';
} else {
    echo 'ce message est sûr';
}
?>

Tous les stockages, excepté Pop3, supportent les dossiers, également appelés boîtes aux lettres. L'interface implémentée par tous les stockages supportant les dossiers s'appelle Zend_Mail_Storage_Folder_Interface. En outre toutes ces classes ont un paramètre facultatif additionnel appelé 'folder', qui est le dossier choisi après ouverture, dans le constructeur.

Pour les stockages locaux vous devez employer les classes séparées appelées Zend_Mail_Storage_Folder_Mbox ou Zend_Mail_Storage_Folder_Maildir. Tous les deux ont besoin d'un paramètre nommé 'dirname' avec le nom du dossier de base. Le format pour le maildir est comme définie dans maildir++ (avec un point comme délimiteur par défaut), Mbox est une hiérarchie de dossiers avec des fichiers Mbox. Si vous n'avez pas un dossier de Mbox appelé INBOX dans votre dossier de base Mbox vous devez placer un autre dossier dans le constructeur.

Zend_Mail_Storage_Imap supporte déjà des dossiers par défaut. Exemples pour ouvrir ces stockages :

<?php
// mbox avec dossiers
$mail = new Zend_Mail_Storage_Folder_Mbox(array('dirname' => '/home/test/mail/'));

// mbox avec un dossier par défaut nommé INBOX, fontionne aussi
// avec Zend_Mail_Storage_Folder_Maildir et Zend_Mail_Storage_Imap
$mail = new Zend_Mail_Storage_Folder_Mbox(array('dirname' => '/home/test/mail/',
                                                'folder'  => 'Archive'));

// maildir avec dossiers
$mail = new Zend_Mail_Storage_Folder_Maildir(array('dirname' => '/home/test/mail/'));

// maildir avec deux-points comme délimiteur, comme suggéré dans Maildir++
$mail = new Zend_Mail_Storage_Folder_Maildir(array('dirname' => '/home/test/mail/'
                                                   'delim'   => ':'));

// imap est le même avec ou sans dossier
$mail = new Zend_Mail_Storage_Imap(array('host'     => 'example.com'
                                         'user'     => 'test',
                                         'password' => 'test'));
?>

Avec la méthode getFolders($root = null) vous pouvez obtenir la hiérarchie des dossiers en commençant par le dossier racine ou le dossier fourni. Elle est retournée comme instance de Zend_Mail_Storage_Folder, qui implémente RecursiveIterator et tous ses enfants sont également des instances de Zend_Mail_Storage_Folder. Chacune de ces instances à des noms locaux et globaux retournés par les méthodes getLocalName() et getGlobalName(). Le nom global est le nom absolu du dossier racine (délimiteurs y compris), le nom local est le nom dans le dossier parent.

Si vous employez l'itérateur, la clé de l'élément courant est le nom local. Le nom global est également retourné par la méthode magique __toString(). Quelques dossiers peuvent ne pas être sélectionnables, ce qui veut dire qu'ils ne peuvent pas stocker des messages et les choisir entraînerait une erreur. Ceci peut être vérifié avec la méthode isSelectable(). Ainsi il est très facile de produire l'arbre entier dans une vue :

<?php
$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>';
?>

Les dossiers choisis courants sont retournés par la méthode getSelectedFolder(). Changer de dossier est fait avec la méthode selectFolder(), qui a besoin du nom global comme paramètre. Si vous voulez éviter d'écrire des délimiteurs vous pouvez également employer les propriétés d'une instance de Zend_Mail_Storage_Folder :

<?php
// selon votre stockage et ses réglages $rootFolder->Archive->2005
// est la même chose que :
//   /Archive/2005
//  Archive:2005
//  INBOX.Archive.2005
//  ...
$folder = $mail->getFolders()->Archive->2005;
echo 'Le précédent dossier était ' . $mail->getSelectedFolder() . "Le nouveau dossier est $folder\n";
$mail->selectFolder($folder);
?>