Introduction aux fonctions IMAP de PHP

Exchange Server est un logiciel de messagerie créé par Microsoft pour concurrencer Lotus Domino d'IBM. Permettant d'envoyer et de recevoir des courriers électroniques et d'échanger d'autres formes de communication interactive par le biais de réseaux informatiques.

Microsoft Exchange Server représente 65 % du marché de la messagerie professionnelle en France.

C'est un produit de la gamme des serveurs Microsoft, conçu pour la messagerie électronique, mais aussi pour la gestion d'agenda, de contacts et de tâches, qui assure le stockage des informations et permet des accès à partir de clients mobiles (Outlook Mobile Access, Exchange Active Server Sync) et de clients Web (navigateurs tels que Internet Explorer, Mozilla Firefox, Safari (Apple)…).

Suivant la vague du cloud computing (Tutoriel pour débutant sur le cloud computing), Microsoft Exchange est, depuis 2009, disponible au travers d'une offre SaaS appelée Microsoft Online Services sous le nom d'Exchange Online.

Le protocole SMTP, Simple Mail Transfer Protocol (littéralement « Protocole simple de transfert de courrier »), est un protocole de communication utilisé pour transférer le courrier électronique (courriel) vers les serveurs de messagerie électronique.

Comme son nom l'indique, SMTP est un protocole assez simple. On commence par spécifier l'expéditeur du message puis, le ou les destinataires d'un message, puis, en général après avoir vérifié leur existence, le corps du message est transféré. Il est possible de tester un serveur SMTP en utilisant la commande telnet sur le port 25 d'un serveur distant.

Le logiciel Sendmail est l'un des premiers serveurs de messagerie électronique à utiliser SMTP. Depuis, la plupart des clients de messagerie peuvent utiliser SMTP pour envoyer les messages. Certains nouveaux serveurs sont apparus, comme Postfix, Qmail et Exchange de Microsoft (qui accomplit également d'autres fonctions).

Comme le protocole utilisait du texte en ASCII (7 bits), il ne fonctionnait pas pour l'envoi de n'importe quels octets dans des fichiers binaires. Pour pallier ce problème, des standards comme MIME ont été développés pour permettre le codage des fichiers binaires au travers de SMTP. Aujourd'hui, la plupart des serveurs SMTP acceptent le MIME sur 8 bits, ce qui permet de transférer des fichiers binaires presque aussi facilement que du texte simple.

SMTP utilise TCP pour le transfert des données.

SMTP ne permet pas de récupérer à distance des courriels arrivés dans une boîte aux lettres sur un serveur. Les standards Post Office Protocol (POP) et IMAP ont été créés dans ce but.

Le protocole POP (Post Office Protocol), en français le protocole du bureau de poste, est un protocole qui permet de récupérer les courriers électroniques situés sur un serveur de messagerie électronique.

Cette opération nécessite une connexion à un réseau TCP/IP. Le port utilisé est le 110.

Après la création de POP3 le protocole POP3S a vu le jour pour sécuriser la communication avec le serveur. POP3S utilise le port 995.

POP3 et POP3S utilisent tous deux le protocole de transfert TCP.

Le protocole IMAP, Internet Message Access Protocol est un protocole qui permet de récupérer les courriers électroniques déposés sur des serveurs de messagerie. Son but est donc similaire à POP3, l'autre principal protocole de relève du courrier. Mais contrairement à ce dernier, il a été conçu pour permettre de laisser les messages sur le serveur (nous verrons le fonctionnement et les différences plus tard).

Il comporte des fonctionnalités avancées comme la possibilité de créer des dossiers ou de manipuler les messages directement sur le serveur. Il offre aussi la possibilité de trier ses courriels sur le serveur. Le langage Sieve a été conçu pour permettre de filtrer des messages sur des serveurs sur lesquels l'utilisateur n'a pas le droit d'exécuter des tâches.

Le fait que les messages soient archivés sur le serveur fait que l'utilisateur peut y accéder depuis n'importe où sur le réseau et que l'administrateur peut facilement faire des copies de sauvegarde.

IMAP utilise le port TCP 143. L'utilisation de TLS permet l'accès sécurisé au serveur. La RFC 2595, qui décrit le fonctionnement de TLS avec IMAP, déconseille l'utilisation du port 993 qui avait été préalablement enregistré pour IMAPS (IMAP over SSL).

III-G-1-a. Description▲

III-G-1-b. Liste des paramètres▲

III-G-1-c. Valeurs de retour▲

III-G-1-d. Exemple▲

<?php
    /* 
        $mailbox = '{' adresse du serveur ':' numéro de port '/' protocole '}' nom du dossier (par défaut INBOX) 
        $username = mon.nom@free.fr 
        $password = monMDP
    */    
/* Avec variable */
imap_open("{pop3.free.fr:143/pop3}INBOX","mon.nom@free.fr","monMDP");

/* Sans variable en « dur » */
imap_open("{$mailbox}INBOX","$username","$password");
?>

bool imap_close ( resource $imap_stream [, int $flag = 0 ] )

Termine un flux IMAP.

http://fr2.php.net/manual/fr/function.imap-close.php.

imap_stream : un flux IMAP retourné par la fonction imap_open().

Pour le flag se reporter à la documentation :
http://fr2.php.net/manual/fr/function.imap-close.php.

Cette fonction retourne TRUE en cas de succès ou FALSE si une erreur survient.

<?php
    // Tentative de connexion
    $imapLink = imap_open("{pop3.free.fr:143/pop3}INBOX","mon.nom@free.fr","monMDP");
     
    // Test sur le retour de la fonction imap_open()
    if(!$imapLink) // Échec
    {
        echo "La connexion a échoué.";
    }
    else // Connexion établie
    {
        echo "Connexion établie.";

        // On utilise imap_close() pour fermer la connexion avec en paramètre la ressource retournée par imap_open()
        $imapClose = imap_close($imapLink);
        
        if(!$imapClose) // Échec
        {
            echo "La fermeture a échoué.";
        }
        else
        {
            echo "Fermeture de la connexion réussie.";
        }
    }    
?>

Pour tester ce code, pensez à remplacer les paramètres indiqués ici par ceux correspondant au serveur de votre choix et au compte correspondant. Si vous voyez enfin apparaître le texte « Connexion établie, fermeture de la connexion. », vous avez établi votre connexion à un serveur de messagerie avec succès.

Object imap_check ( resource $imap_stream ).

Vérifie les informations de la boîte aux lettres courante.

http://fr.php.net/manual/fr/function.imap-check.php.

imap_stream : un flux IMAP retourné par la fonction imap_open().

Retourne les informations dans un objet contenant les propriétés suivantes :

• Date - date de dernière modification du contenu de la boîte aux lettres en accord avec la »RFC2822 ;
• Driver - protocole utilisé pour accéder à la boîte aux lettres : POP3, IMAP, NNTP ;
• Mailbox - nom de la boîte aux lettres ;
• Nmsgs - nombre de messages de la boîte aux lettres ;
• Recent - nombre de messages récents de la boîte aux lettres.

Retourne FALSE si une erreur survient.

<?php
    // Tentative de connexion
    $imapLink = imap_open("{pop3.free.fr:143/pop3}INBOX","mon.nom@free.fr","monMDP");
     
    // Test sur le retour de la fonction imap_open()
    if(!$imapLink) // Échec
    {
        echo "La connexion a échoué.";
    }
    else // Connexion établie
    {
        echo "Connexion établie.";

        // On récupère les informations
        $mailBoxInfos = imap_check($imapLink);
        
        if(!$mailBoxInfos) // Échec
        {
            echo "La récupération a échoué.";
        }
        else // On affiche ces informations
        {
            echo "Lecture des informations...";
            echo '<pre>';
                print_r($mailBoxInfos);
                // var_dump($mailBoxInfos);
            echo '</pre>';
        }
        
        // On utilise imap_close() pour fermer la connexion avec en paramètre la ressource retournée par imap_open()
        $imapClose = imap_close($imapLink);
        
        if(!$imapClose) // Échec
        {
            echo "La fermeture a échoué.";
        }
        else
        {
            echo "Fermeture de la connexion réussie.";
        }
    }    
?>

Pour tester ce code, pensez à remplacer les paramètres indiqués ici par ceux correspondant au serveur de votre choix et au compte correspondant. Si vous voyez enfin apparaître le texte  « Connexion établie, (*), fermeture de la connexion. », vous avez établi votre connexion à un serveur de messagerie, vous avez lu des informations, avec succès.

(*) Avec le print_r ou le var_dump vous obtiendrez un objet contenant ceci :

Connexion établie.

Lecture des informations ...
/* print_r */
stdClass Object
(
    [Date] => Mon, 24 Jun 2013 14:51:32 +0100 (CET)
    [Driver] => pop3
    [Mailbox] => {pop3.free.fr:143/pop3/user="mon.nom@free.fr"}INBOX
    [Nmsgs] => 9
    [Recent] => 9
)
/* var_dump */
object(stdClass)(5) 
{
  ["Date"]=>
  string(37) "Mon, 24 Jun 2013 14:51:54 +0100 (CET)"
  ["Driver"]=>
  string(4) "imap"
  ["Mailbox"]=>
  string(54)
  "{www.example.com:143/imap/user="foo@example.com"}INBOX"
  ["Nmsgs"]=>
  int(1)
  ["Recent"]=>
  int(0)
}

array imap_fetch_overview (resource $imap_stream, string $sequence [, int $options = 0 ])

Lit les s des courriers électroniques de la séquence sequence et retourne un sommaire de leur contenu.

http://fr.php.net/manual/fr/function.imap-fetch-overview.php.

imap_stream

Un flux IMAP retourné par la fonction imap_open().

sequence

Une description de la séquence du message. Vous pouvez énumérer les messages désirés avec la syntaxe X,Y, ou récupérer tous les messages d'un intervalle, avec la syntaxe X:Y.

Exemple :
Pour obtenir les messages du numéro 0 au numéro 10 on passera donc en paramètre la chaîne suivante : 0:10.

options

sequence va contenir une séquence d'indice de message ou d'UID, si flags contient FT_UID.

Retourne un tableau d'objets décrivant l'en-tête de chaque message. L'objet ne définira une propriété que si elle existe. Les propriétés possibles sont :

• subject : le sujet du message ;
• from : l'expéditeur ;
• to : le destinataire ;
• date : la date d'expédition ;
• message_id : l'identification du message ;
• references : la référence sur l'id de ce message ;
• in_reply_to : la réponse à cet identifiant de message ;
• size : la taille en octets ;
• uid : UID du message dans la boîte aux lettres ;
• msgno : le numéro de séquence du message dans la boîte ;
• recent : ce message est récent ;
• flagged : ce message est marqué ;
• answered : ce message a donné lieu à une réponse ;
• deleted : ce message est marqué pour l'effacement ;
• seen : ce message est déjà lu ;
• draft : ce message est un brouillon.

<?php
    // Tentative de connexion
    $imapLink = imap_open("{pop3.free.fr:143/pop3}INBOX","mon.nom@free.fr","monMDP");
     
    // Test sur le retour de la fonction imap_open()
    if(!$imapLink) // Échec
    {
        echo "La connexion a échoué.";
    }
    else // Connexion établie
    {
        echo "Connexion établie.";

        // On récupère les informations
        $mailBoxInfos = imap_check($imapLink);
        
        if(!$mailBoxInfos) // Échec
        {
            echo "La récupération a échoué.";
        }
        else // On affiche ces informations
        {
            echo "Lecture des informations...";
            echo '<pre>';
                print_r($mailBoxInfos);
                // var_dump($mailBoxInfos);
            echo '</pre>';
            
            // On récupère la liste des messages
            $mailList = imap_fetch_overview($imapLink,"0:".$mailBoxInfos->Nmsgs);
            
            if(isset($mailList) // La variable existe
            {
                echo "Récupération de la liste des messages...";
                echo '<pre>';
                    print_r($mailList);
                echo '</pre>';
            }
            else
            {
                echo "La récupération de la liste des messages a échoué.";
            }
        }
        
        // On utilise imap_close() pour fermer la connexion avec en paramètre la ressource retournée par imap_open()
        $imapClose = imap_close($imapLink);
        
        if(!$imapClose) // Échec
        {
            echo "La fermeture a échoué.";
        }
        else
        {
            echo "Fermeture de la connexion réussie.";
        }
    }    
?>

Pour tester ce code, pensez à remplacer les paramètres indiqués ici par ceux correspondant au serveur de votre choix et au compte correspondant. Si vous voyez enfin apparaître le texte  « Connexion établie, (*), Récupération de la liste des messages…, [Votre_Liste], fermeture de la connexion. », vous avez établi votre connexion à un serveur de messagerie, vous avez lu des informations et récupéré la liste des messages, avec succès.

bool imap_body ( resource $imap_stream , int $msg_number [, int $options = 0 ] ).

imap_body() retourne le corps du message numéro msg_number de la boîte aux lettres courante.

imap_body() va retourner une copie brute du corps du message. Pour extraire les sous-parties MIME du message, utilisez imap_fetchstructure() pour analyser la structure, et imap_fetchbody() pour extraire une copie d'une des sous-parties.

http://fr.php.net/manual/fr/function.imap-body.php.

imap_stream

Un flux IMAP retourné par la fonction imap_open().

msg_number

Le numéro du message.

options

Le paramètre options optionnel est un masque qui peut contenir les valeurs suivantes :

• FT_UID - msg_number est un UID ;
• FT_PEEK - ne pas lever le drapeau \Seen (Message lu) s'il n'est pas déjà levé ;
• FT_INTERNAL - la chaîne renvoyée est au format interne, et ne va pas canoniser les CRLF.

Retourne le corps du message spécifié, sous la forme d'une chaîne de caractères.

<?php
    // Tentative de connexion
    $imapLink = imap_open("{pop3.free.fr:143/pop3}INBOX","mon.nom@free.fr","monMDP");
     
    // Test sur le retour de la fonction imap_open()
    if(!$imapLink) // Échec
    {
        echo "La connexion a échoué.";
    }
    else // Connexion établie
    {
        echo "Connexion établie.";

        // On récupère les informations
        $mailBoxInfos = imap_check($imapLink);
        
        if(!$mailBoxInfos) // Échec
        {
            echo "La récupération a échoué.";
        }
        else // On affiche ces informations
        {
            echo "Lecture des informations &#8230;";
            echo '<pre>';
                print_r($mailBoxInfos);
                // var_dump($mailBoxInfos);
            echo '</pre>';
            
            // On récupère la liste des messages
            $mailList = imap_fetch_overview($imapLink,"0:".$mailBoxInfos->Nmsgs);
            
            if(isset($mailList) // La variable existe
            {
                echo "Récupération de la liste des messages...";
                echo '<pre>';
                    print_r($mailList);
                echo '</pre>';
                
                $nombreMessage = imap_num_msg($imapLink); // Retourne le nombre de messages dans la boîte aux lettres courante

                while($nombreMessage > 0) // Si seulement il y a des messages on les affiche
                {
                    $corpsMail = imap_body($imapLink, $nombreMessage);
                    if($corpsMail == null)
                    {
                        echo "Le corps du message est vide...";
                    }
                    else
                    {
                        echo 'Récupération du corps du '.$nombreMessage.' message...';
                        echo '<pre>';
                            print_r($corpsMail);
                        echo '</pre>';
                        $nombreMessage--;
                    }
                } 
            }
            else
            {
                echo "La récupération de la liste des messages a échoué.";
            }
        }
        
        // On utilise imap_close() pour fermer la connexion avec en paramètre la ressource retournée par imap_open()
        $imapClose = imap_close($imapLink);
        
        if(!$imapClose) // Échec
        {
            echo "La fermeture a échoué.";
        }
        else
        {
            echo "Fermeture de la connexion réussie.";
        }
    }    
?>

Pour tester ce code, pensez à remplacer les paramètres indiqués ici par ceux correspondant au serveur de votre choix et au compte correspondant. Si vous voyez enfin apparaître le texte « Connexion établie, (*), Récupération de la liste des messages …, [Votre_Liste], fermeture de la connexion. », vous avez établi votre connexion à un serveur de messagerie, vous avez lu des informations et récupéré la liste des messages, avec succès.