4D Doc Center : IMAP

4D Internet Commands v14

IMAP_SetCurrentMB


IMAP_SetCurrentMB ( imap_ID ; nomBL ; nbMsg ; nbNouvMsg ; marqListe ; marqPermanent ; 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
marqListe	Texte	Liste des marqueurs utilisés dans la boîte aux lettres
marqPermanent	Texte	Liste des marqueurs modifiables
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_SetCurrentMB vous permet d’ouvrir une session (c’est-à-dire, de sélectionner une boîte aux lettres courante) et donc de gérer les messages de la boîte aux lettres spécifiée.

Une seule session peut être ouverte à la fois pendant une connexion ; les accès simultanés à plusieurs boîtes aux lettres nécessitent plusieurs connexions (plusieurs IMAP_Login). La commande IMAP_SetCurrentMB referme automatiquement la session courante avant de démarrer la nouvelle. Par conséquent, si une boîte aux lettres était définie comme courante et que l’exécution de la commande IMAP_SetCurrentMB échoue, vous n’avez plus de boîte aux lettres courante.

Vous pouvez fermer une session (c’est-à-dire, fermer la boîte aux lettres courante) sans sélectionner de nouvelle boîte aux lettres : il suffit d’exécuter la commande IMAP_SetCurrentMB avec un nom de boîte aux lettres (nomBL) inexistant puis la commande IMAP_CloseCurrentMB ou IMAP_Logout lors du traitement de l’erreur.

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 à rendre courante.

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 marqListe retourne la liste des marqueurs utilisés dans la boîte aux lettres courante. Notez que seuls les marqueurs listés dans le paramètre marqPermanent peuvent être modifiés.

Le paramètre marqPermanent retourne la liste des marqueurs pouvant être modifiés de manière permanente (à l’exception du marqueur \Recent, géré par le serveur IMAP). Notez que la chaîne contenue dans le paramètre peut également inclure le marqueur spécial \*, ce qui signifie que des mots-clés peuvent être créés en stockant ces marqueurs dans la boîte aux lettres (cf. commande IMAP_SetFlags). marqPermanent retourne une chaîne vide lorsque tous les marqueurs listés dans le paramètre marqListe peuvent être modifiés.

Le paramètre uniqueIDBL retourne le numéro d’identification unique de la boîte aux lettres courante. Cet identifiant est particulièrement utile lorsqu’une boîte aux lettres est supprimée puis qu’une nouvelle boîte est créée avec le même nom par la suite. Dans ce cas, seul le numéro unique permet au client d’identifier la nouvelle boîte aux lettres.