IMAP_GetMBStatus

4D Internet Commands v16

IMAP_GetMBStatus


IMAP_GetMBStatus ( imap_ID ; nomBL ; nbMsg ; nbNouvMsg ; nbMsgNonLus ; uniqueIDBL ) -> Résultat

Paramètre	Type	Description
imap_ID	Entier long	Référence de connexion IMAP
nomBL	Texte	Nom de boîte aux lettres
nbMsg	Entier long	Nombre de messages dans la boîte aux lettres spécifiée
nbNouvMsg	Entier long	Nombre de messages avec le marqueur \Recent
nbMsgNonLus	Entier long	Nombre de messages sans le marqueur \Seen
uniqueIDBL	Entier long	Numéro d’identification unique de la boîte aux lettres spécifiée
Résultat	Entier	Code d'erreur

Description

La commande IMAP_GetMBStatus retourne le statut des paramètres de la boîte aux lettres spécifiée par nomBL. Cette commande ne modifie ni la boîte aux lettres courante (cf. IMAP_SetCurrentMB), ni le statut des messages présents dans la boîte aux lettres (en particulier, la commande ne supprime généralement pas les marqueurs \Recent, toutefois ce fonctionnement peut varier en fonction des paramétrages du serveur IMAP4). Cette commande alternative permet d’obtenir le statut des paramètres sans désélectionner la boîte aux lettres courante.

IMAP_GetMBStatus est particulièrement utile pour :

Tester ou récupérer le numéro d’identification unique d’une boîte aux lettres.
Vérifier les messages récents ou non lus d’une boîte aux lettres sans ouvrir de session spécifique.

Important : Il est fortement recommandé de ne pas utiliser la commande IMAP_GetMBStatus avec la boîte aux lettres courante. Dans ce cas en effet, il y a risque de désynchronisation des informations (concernant en particulier les nouveaux messages).

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

Le paramètre nomBL contient le nom complet de la boîte aux lettres dont vous souhaitez obtenir les paramètres de statut.

Note : A la différence de la commande IMAP_ListMBs, le paramètre nomBL n’accepte pas de caractères “Joker” avec IMAP_GetMBStatus.

Le paramètre nbMsg retourne le nombre de messages présents dans la boîte aux lettres (retourne -1 en cas d’erreur).

Le paramètre nbNouvMsg retourne le nombre de messages récents présents dans la boîte aux lettres (retourne -1 en cas d’erreur).

Le paramètre nbMsgNonLus retourne le nombre de messages non lus présents dans la boîte aux lettres (retourne -1 en cas d’erreur).

Le paramètre uniqueIDBL retourne le numéro d’identification unique de la boîte aux lettres (retourne -1 en cas d’erreur).
Avec le protocole IMAP4, le nom n’est pas suffisant pour identifier une boîte aux lettres. Pour cela, un numéro d’identification unique est attribué à chaque boîte aux lettres. Cet identifiant est particulièrement utile pour synchroniser des tâches.
Ainsi, vous pouvez vérifier si une boîte aux lettres “A” a été renommée “B” ou supprimée, simplement en vérifiant son numéro d’identification unique. De même, l’identifiant vous permet de savoir si une boîte aux lettres “A” a été supprimée puis remplacée par une nouvelle boîte nommée “A”.

Voir aussi

IMAP_GetFlags
IMAP_ListMBs
IMAP_SetCurrentMB
IMAP_SetFlags