4D Doc Center : IMAP

4D Internet Commands v14

IMAP_Download


IMAP_Download ( imap_ID ; numéroMsg ; enTêteSeul ; nomFichier ; 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
enTêteSeul	Entier	0 = Message entier, 1 = En-tête seul
nomFichier	Texte	Nom de fichier local
		Nom de fichier local utilisé
majSeen	Entier	0 = Mise à jour du marqueur \Seen, 1 = Ne pas le mettre à jour
Résultat	Entier	Code d’erreur

Description

La commande IMAP_Download permet de télécharger un message d’un serveur IMAP en local sur disque. Tout message IMAP contenant des fichiers joints ou dont la taille est supérieure à 32 Ko devra être téléchargé avec cette commande. Les fichiers joints peuvent être extraits uniquement à partir d’un message préalablement téléchargé.

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

Le paramètre numéroMsg désigne le message à examiner. Le numéroMsg représente la position du message dans la liste courante des messages. Attention, le numéroMsg d’un message n’est pas une valeur stable, il peut différer d’une session à l’autre.

Le paramètre enTêteSeul vous permet de spécifier si vous souhaitez récupérer la totalité du message ou uniquement les informations des en-têtes.

Le paramètre nomFichier désigne le nom et/ou l’emplacement du fichier dans lequel vous souhaitez enregistrer le message. Cette valeur peut être spécifiée de trois manières :

""= Enregistre le fichier dans le dossier défini par IMAP_SetPrefs, avec le nom “temp1” (si un fichier de ce nom existe déjà, les noms “temp2”, “temp3”, etc., sont essayés).
"nomFichier" = Enregistre le fichier dans le dossier défini par IMAP_SetPrefs, avec le nom nomFichier.
"Chemin:nomFichier" = Enregistre le fichier en utilisant le chemin spécifié par nomFichier.

Dans les deux premiers cas, en l’absence de dossier spécifié par IMAP_SetPrefs, le message est enregistré dans le dossier de la structure de la base de données (avec 4D monoposte) ou dans le dossier de 4D Client (avec 4D Server).

Après l’exécution de la commande, le nom final du fichier est retourné dans le paramètre nomFichier. Si vous tentez d’appeler IMAP_Download avec un nomFichier qui existe déjà dans le dossier de téléchargement, ce nom est incrémenté et le nom réellement enregistré sur disque est retourné.

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.