IMAP_MsgLstInfo

4D v19

IMAP_MsgLstInfo


IMAP_MsgLstInfo ( imap_ID ; premierMsg ; dernierMsg ; tabTaillesMsg ; tabNumMsg ; tabIDMsg ) -> 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
tabTaillesMsg	Tableau entier long	Tableau des tailles
tabNumMsg	Tableau entier long	Tableau des numéros de messages
tabIDMsg	Tableau entier long	Tableau des ID uniques
Résultat	Entier	Code d’erreur

Description

La commande IMAP_MsgLstInfo retourne la taille, le numéro et l’ID unique d’un ensemble de messages contenus dans la boîte aux lettres courante (définie par la commande IMAP_SetCurrentMB). Ces informations sont renvoyées dans trois tableaux, chaque élément de tableau correspondant à un message. Les tableaux passés en paramètres doivent être déclarés, en revanche leur nombre d’éléments n’a pas d’importance : la commande IMAP_MsgLstInfo les redimensionne au nombre de messages récupérés.

La commande IMAP_MsgLstInfo ne renvoie pas d’erreur si elle ne parvient pas à récupérer des informations sur un message particulier. Dans ce cas, la commande ignore le message et ne crée pas d’élément correspondant dans les tableaux. Par conséquent, si la commande réussit à lire tous les messages, le tableau tabNumMsg contiendra une suite continue de valeurs numériques séquentielles. En cas de problème, des numéros seront manquants dans la suite numérique de tabNumMsg.

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.

Le tableau tabTaillesMsg reçoit la taille de chaque message dont le numéro est compris entre premierMsg et dernierMsg.

Le tableau tabNumMsg reçoit les numéros de chaque message.

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

Voir aussi

IMAP_SetCurrentMB