4D Doc Center : POP3

4D Internet Commands v14

POP3_GetMessage


POP3_GetMessage ( pop3_ID ; numéroMsg ; décalage ; longueur ; texteMsg ) -> Résultat

Paramètre	Type	Description
pop3_ID	Entier long	Référence d'une connexion POP3
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
texteMsg	Texte	Texte du message
Résultat	Entier	Code d'erreur

Description

La commande POP3_GetMessage retourne le contenu du message désigné par numéroMsg dans la boîte aux lettres référencée par pop3_ID. Sauf spécification contraire de la commande POP3_SetPrefs, les caractères Retour à la ligne (Line feed) à l'intérieur du message sont supprimés. La commande POP3_GetMessage renvoie l'intégralité du message, y compris les informations des zones d'en-tête.

pop3_ID contient la référence d'une session ouverte avec POP3_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 en fonction des suppressions effectuées.

Le paramètre décalage vous permet d'indiquer la position du caractère (calculée par rapport au début du message) à 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. La longueur maximale de ce paramètre étant limitée à 32 000 caractères pour des raisons historiques, le paramètre longueur doit être inférieur à 32 000. Les messages dont la taille est supérieure doivent être récupérés sur disque au moyen de la commande POP3_Download.

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