11.8 imaplib --- Client pour le protocole IMAP4

Ce module définit une classe, IMAP4, qui encapsule une connexion avec un serveur IMAP4 et implémente le protocole client IMAPrev1 tel que défini dans RFC 2060. Il fournit une compatibilité ascendante avec les serveurs IMAP4 (RFC 1730), mais notez que la commande "STATUS" n'est pas prise en charge dans IMAP4.

Une classe unique est fournie par le module imaplib:

IMAP4([hote[, port]])
La classe qui implémente le protocole IMAP4. La connexion est créée et la version de protocole (IMAP4 or IMAP4rev1) est déterminée quand l'instance est initialisée. Si hote n'est pas spécifié, '' (l'hôte local) est utilisé. Si port est omis, le port IMAP4 standard (143) est utilisé.

Deux exceptions sont définies comme attributs de la classe IMAP4:

IMAP4.error
Exception déclenchée sur toutes les erreurs. La cause de l'exception est passée au constructeur sous forme de chaîne de caractères.

IMAP4.abort
Les erreurs de serveur IMAP4 provoquent le déclenchement de cette exception. C'est une sous-classe de IMAP4.error. Notez que la fermeture de l'instance et l'instanciation d'une nouvelle permettra généralement de s'en sortir.

IMAP4.readonly
Cette exception est déclenchée quand une boîte aux lettres accessible en écriture voit son état modifié par le serveur. C'est une sous-classe de l'exception IMAP4.error. Un autre client a maintenant la permission d'écrire, et il faudra ré-ouvrir la boîte aux lettres pour obtenir de nouveau la permission d'écrire.

Les fonctions utilitaires suivantes sont définies:

Internaldate2tuple(datestr)
Convertit une chaîne IMAP4 INTERNALDATE en Temps Universel Coordonné. Retourne un tuple du module time.

Int2AP(num)
Convertit un entier en une représentation chaîne utilisant les caractères de l'ensemble [A .. P].

ParseFlags(flagstr)
Convertit une réponse IMAP4 "FLAGS" en un tuple d'indicateurs individuels.

Time2Internaldate(heure)
Convrtit un tuple du module time en une représentation IMAP4 "INTERNALDATE". Retourne une chaîne de caractères de la forme: "JJ-Mmm-AAAA HH:MM:SS +HHMM" (y compris les doubles guillemets).

Notez que les numéros de messages IMAP4 changent quand la boîte aux lettres change, de sorte qu'il est hautement recommandé de se servir plutôt des UIDs, avec la commande UID.

A la fin du module, il y a une section de test qui contient un exemple d'utilisation plus complet.

Voir aussi:

On peut trouver des documents décrivant le protocole, et des sources et des binaires pour les serveurs qui les implémentent, sur l'IMAP Information Center de l'Université de Washington (http://www.cac.washington.edu/imap/).


Sous-sections
  1. Objets IMAP4
  2. Exemple IMAP4