IMAP_GetMessage

4D v20

IMAP_GetMessage


IMAP_GetMessage ( imap_ID ; numéroMsg ; décalage ; longueur ; partieMsg ; texteMsg {; majSeen} ) -> Résultat

Paramètre	Type	Description
imap_ID	Entier long	Référence de connexion IMAP
numéroMsg	Entier long	Numéro du message
décalage	Entier long	Caractère à partir duquel commencer la récupération
longueur	Entier long	Nombre de caractères à renvoyer
partieMsg	Entier	0 = Message entier, 1 = En-tête uniquement, 2 = Corps uniquement
texteMsg	Texte	Texte du message
majSeen	Entier	0 = Mettre à jour le marqueur \Seen, 1 = Ne pas le mettre à jour
Résultat	Entier	Code d’erreur

Description

La commande IMAP_GetMessage retourne le texte du message désigné par numéroMsg dans la boîte aux lettres courante définie par la commande IMAP_SetCurrentMB. Sauf spécification contraire de la commande IMAP_SetPrefs, les caractères Retour à la ligne (Line feed) à l’intérieur du message sont supprimés.
La commande IMAP_GetMessage peut retourner soit l’intégralité du message, y compris les informations des zones d’en-tête, soit uniquement une partie du message (en-tête ou corps) en fonction de la valeur du paramètre partieMsg.

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

Le paramètre numéroMsg désigne le message à récupérer dans la boîte aux lettres. Le numéroMsg représente la position du message dans la liste courante de messages. Attention, le numéroMsg d’un message n’est pas une valeur stable, il diffère d’une session à l’autre.

Le paramètre décalage vous permet d’indiquer la position du caractère (calculée par rapport au début de la partie du message à récupérer) à partir duquel commencer la lecture. Dans la plupart des cas, vous passerez 0 (zéro) dans ce paramètre.

Le paramètre longueur indique le nombre de caractères à récupérer au-delà de la position de décalage.

Le paramètre partieMsg permet d’indiquer la partie du message à récupérer. Vous pouvez utiliser les valeurs 0, 1 ou 2 :

0 = Message entier
1 = En-tête uniquement
2 = Corps uniquement (c’est-à-dire à partir du premier Text/ plain rencontré).
Lorsque vous récupérez le message entier ou l’en-tête uniquement, vous obtenez du texte brut non décodé. Lorsque vous récupérez le corps uniquement, le texte obtenu 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).

Le paramètre optionnel majSeen vous permet d’indiquer si le marqueur \Seen (“message lu”) doit être ajouté ou non aux marqueurs du message. Vous pouvez passer une des valeurs suivantes :

0 = Ajouter le marqueur \Seen (valeur par défaut)
1 = Ne pas ajouter le marqueur \Seen

Si vous omettez le paramètre majSeen, le marqueur \Seen est ajouté par défaut au message.

Le texte récupéré est retourné dans la variable texteMsg.

Voir aussi

IMAP_Download
IMAP_Login
IMAP_SetCurrentMB
IMAP_SetPrefs