4D Doc Center : IMAP

4D Internet Commands v14

IMAP_MsgLst


IMAP_MsgLst ( imap_ID ; premierMsg ; dernierMsg ; tabEnTêtesMsg ; tabNumMsg ; tabIDMsg ; tabValeursMsg ) -> Résultat

Paramètre	Type	Description
imap_ID	Entier long	Référence de connexion IMAP
premierMsg	Entier long	Numéro du premier message
dernierMsg	Entier long	Numéro du dernier message
tabEnTêtesMsg	Tableau chaîne	Tableau des en-têtes à récupérer
tabNumMsg	Tableau entier long	Tableau des numéros de messages
tabIDMsg	Tableau entier long	Tableau ID uniques
tabValeursMsg	Tableau alpha 2D, Tableau texte 2D	Tableau 2D des valeurs des en-têtes
Résultat	Entier	Code d’erreur

Description

La commande IMAP_MsgLst permet d’obtenir des informations spécifiques sur le contenu d’une boîte aux lettres. Seules les valeurs des en-têtes peuvent être récupérées par cette commande. Le contenu des en-têtes est automatiquement décodé et converti si nécessaire (reportez-vous à la description de la commande POP3_Charset pour plus d’informations sur les règles de conversion et de décodage).

imap_ID contient la référence d’une session ouverte avec IMAP_Login.

Le paramètre premierMsg désigne le numéro du premier message à examiner. Ce numéro représente la position d’un message dans la liste de tous les messages de la boîte aux lettres courante.

Le paramètre dernierMsg indique le numéro du dernier message à examiner. Ce numéro représente la position d’un message dans la liste de tous les messages de la boîte aux lettres courante.

Note : Si le paramètre premierMsg est supérieur au paramètre dernierMsg, les commandes IMAP_Delete, IMAP_MsgLstInfo, IMAP_MsgLst, IMAP_SetFlags, IMAP_GetFlags et IMAP_CopyToMB ne retournent pas d’erreur et ne font rien.

Vous remplissez le tableau alphanumérique ou texte tabEnTêtesMsg avec les noms des en-têtes que vous souhaitez récupérer.

Le tableau tabNumMsg retourne les numéros des messages compris entre premierMsg et dernierMsg.

Le tableau tabIDMsg reçoit les ID uniques de chaque message.

Le tableau 2D tabValeursMsg reçoit le contenu de chaque en-tête désigné par tabEnTêtesMsg. A chaque en-tête demandé correspond une “ligne” du tableau tabValeursMsg.

Exemple

 aEnTêtes{1}:="Date:"

 aEnTêtes{2}:="From:"

 aEnTêtes{3}:="Subject:"

 IMAP_MsgLst(IMAP_ID;vPremier;vDernier;aEnTêtes;aNumMsg;aUID;aValeurs)

aValeurs{1}{1} contient par exemple "Jeudi 19 novembre 1998, 00:24:02 -0800"
aValeurs{2}{1} contient par exemple "Jack@4d.com"
aValeurs{3}{1} contient par exemple "Appelez votre femme"

Les erreurs sont gérées de la façon suivante :
1) Seules les erreurs relatives à la communication sont renvoyées. Si la commande ne peut pas achever sa tâche en raison d’une erreur (réseau, syntaxe, serveur, etc.), le code d’erreur approprié est renvoyé.
2) Si un message appartenant à l’intervalle spécifié n’existe pas ou comporte une erreur :
- Aucun élément de tableau n’est créé pour ce message.
- Aucune erreur n’est renvoyée.
3) L’incapacité à localiser un ou plusieurs en-têtes dans un message ne constitue pas une erreur :
- Un élément de tableau est créé pour le message.
- Les éléments des tableaux aNumMsg et aUID contiennent les valeurs appropriées.
- Pour chaque en-tête introuvable dans le message, une chaîne vide ("") est renvoyée à l’élément de tableau.
- Aucun code d’erreur n’est renvoyé.