IMAP_Download

4D Internet Commands v16

IMAP_Download


IMAP_Download ( imap_ID ; numMsg ; encabSolo ; nomArchivo ; actSeen ) -> resultado

Parámetro	Tipo	Descripción
imap_ID	Entero largo	Referencia de conexión IMAP
numMsg	Entero largo	Número del mensaje
encabSolo	Entero	0 = Mensaje entero, 1 = Encabezado únicamente
nomArchivo	Texto	Nombre del archivo local
		Nombre del archivo local utilizado
actSeen	Entero	0 = Añadir marcador \Seen; 1= No añadir el marcador \Seen
resultado	Entero	Código de error

Descripción

El comando IMAP_Download está diseñado para recuperar un mensaje de un servidor IMAP, grabándolo en el disco local. Todo mensaje IMAP que contiene archivos adjuntos o cuyo tamaño es mayor a 32 K debe ser descargado con este comando. Los archivos adjuntos sólo pueden extraerse de los mensajes recuperados de esta manera.

imap_ID es una referencia entero largo a una conexión abierta creada con IMAP_Login.

numMsg es un valor entero largo que indica cual mensaje en el buzón recuperar. numMsg representa la posición de un mensaje dentro de la lista actual de mensajes. El numMsg de un mensaje no es un valor estable, difiere de una sesión a otra.

encabSolo es un valor entero que indica si se debe recuperar todo el mensaje o sólo la información del encabezado.

nomArchivo contiene el nombre del archivo y la ruta de acceso opcional donde desea guardar el mensaje. Este valor se puede especificar de tres formas diferentes:

"" = Guarda el archivo en la carpeta definida por IMAP_SetPrefs, con el nombre "temp1" (si un archivo con el mismo nombre ya existe, los nombres de archivo "temp2", "temp3", etc. se utilizarán hasta que se encuentre un nombre de archivo sin utilizar).
"NomArchivo" = Guarda el archivo en la carpeta definida por IMAP_SetPrefs con el nombre nomArchivo.
"Ruta:nomArchivo" = Guarda el archivo en la ruta especificada con el nombre nomArchivo.

En los dos primeros casos, si IMAP_SetPrefs, no especifica ninguna carpeta, el mensaje se guardará en la misma carpeta que la estructura de la base de datos (con 4D monopuesto) o en la carpeta 4D Client (con 4D Server).

Después de que el archivo se guarde en el disco, el nombre final del archivo se devuelve en el parámetro nomArchivo. Si intenta llamar a IMAP_Download con un nombre de archivo que ya existe dentro de la carpeta de descarga, el nombre se incrementa numéricamente y su nuevo valor como se guarda en el disco será devuelto a la variable nomArchivo.

actSeen es un valor entero que indica si el marcador \Seen se debe agregar a la lista de marcadores del mensaje. Este parámetro es opcional y se utiliza un valor por defecto si no se pasa este parámetro:

0 = Añadir el marcador \Seen
1 = No añadir el marcador \Seen

El valor por defecto es 0 lo que significa implícitamente, añadir el marcador \Seen.

Ver también

IMAP_GetMessage
IMAP_SetPrefs