4D Doc Center : POP3

4D Internet Commands v14

POP3_MsgLst


POP3_MsgLst ( pop3_ID ; départ ; fin ; tabEnTêtesMsg ; tabNumMsg ; tabIDMsg ; tabValeursMsg ) -> Résultat

Paramètre	Type	Description
pop3_ID	Entier long	Référence d'une connexion POP3
départ	Entier long	Numéro du premier message
fin	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 message
tabIDMsg	Tableau chaîne	Tableau alphanumérique des 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 POP3_MsgLst permet d'obtenir des informations contenues dans les en-têtes d'un ensemble de messages. 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 2D tabValeursMsg reçoit le contenu des en-têtes. A chaque en-tête demandé correspond une "ligne" du tableau tabValeursMsg.

La commande POP3_MsgLst ne peut renvoyer que le contenu des en-têtes, elle ne peut pas servir à récupérer le corps d'un message.

Note : Les champs d’en-tête étant susceptibles de contenir des caractères étendus, vous pouvez automatiser la gestion de ceux-ci à l’aide de la commande POP3_Charset.

Exemple

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

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

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

 POP3_MsgLst(◊POP3_ID;vPremier;vDernier;aEnTêtes;aNumMsg;aUID;aValeurs)

 aValeurs{1}{1} ` par exemple "Jeudi 19 novembre 1998, 00:24:02 -0800"

 aValeurs{2}{1} ` par exemple "Jack@4d.com"

 aValeurs{3}{1} ` 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 de tableau "numéro" et "ID" 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é.

Note : Si le paramètre premierMsg est supérieur au paramètre dernierMsg, cette commande ne fait rien. Aucune erreur n'est renvoyée.