4D Doc Center : IMAP

4D Internet Commands v14

IMAP_MsgLst


IMAP_MsgLst ( imap_ID ; primerMsg ; ultimoMsg ; arrayEncabMsg ; arrayNumMsg ; arrayIDMsg ; arrayValoresMsg ) -> resultado

Parámetro	Tipo	Descripción
imap_ID	Entero largo	Referencia de conexión IMAP
primerMsg	Entero largo	Número del primer mensaje
ultimoMsg	Entero largo	Número del último mensaje
arrayEncabMsg	Array cadena	Array de encabezados a recuperar
arrayNumMsg	Array entero largo	Array de los números de mensajes
arrayIDMsg	Array entero largo	Array ID únicos
arrayValoresMsg	Array 2D Cadena, Array texto 2D	Array 2D de los valores de los encabezados
resultado	Entero	Código de error

Descripción

El comando IMAP_MsgLst se utiliza para obtener información específica sobre el contenido de los buzones. Permite al usuario solicitar columnas específicas de la lista de mensajes. Este comando sólo puede devolver los valores de los encabezados, no se puede utilizar para recuperar el cuerpo de un mensaje. El contenido de los encabezados es decodificado automáticamente y convertido si es necesario (ver la descripción del comando POP3_Charset para obtener más información sobre la decodificación y las reglas de conversión).

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

primerMsg es un número entero largo que especifica el número del primer mensaje a examinar. El número de mensaje es un valor que representa la posición de un mensaje en la lista de todos los mensajes en el buzón de trabajo actual.

ultimoMsg es un número entero largo que indica el número del último mensaje a examinar. El número de mensaje es un valor que representa la posición de un mensaje en la lista de todos los mensajes en el buzón de trabajo actual.

Nota: los comandos IMAP_Delete, IMAP_MsgLstInfo, IMAP_MsgLst, IMAP_SetFlags, IMAP_GetFlags y IMAP_CopyToMB no devuelven un error si primerMsg es mayor que el ultimoMsg. En caso de que esto ocurra, el comando no hace nada.

arrayEncabMsg es un array alfanumérico o texto que lista los encabezados a recuperar.

arrayNumMsg devuelve los números de los mensajes entre primerMsg y ultimoMsg.

arrayIdMsg recibe los identificadores únicos de los mensajes entre primerMsg y ultimoMsg.

arrayValoresMsg recibe los datos para cada encabezado especificado por arrayEncabMsg. A cada encabezado solicitado le corresponde una línea del array arrayValoresMsg.

Ejemplo

 aHeaders{1}:="Date:"

 aHeaders{2}:="From:"

 aHeaders{3}:="Subject:"

 IMAP_MsgLst(IMAP_ID;vStart;vEnd;aHeaders;aMsgNum;aMsgId;aValues)

aValues{1}{1} contiene por ejemplo “Jueves, 19 de noviembre 00:24:02 -0800”
aValues{2}{1} contiene por ejemplo “Jack@4d.com”
aValues{3}{1} contiene por ejemplo “Llame a su esposa”

Los errores se manejan de esta forma:

1) Sólo se devuelven los códigos de error relacionados con la comunicación. Si el comando no puede completar su tarea debido a un error (red, sintaxis, servidor, etc.), se devuelve el código de error correspondiente.

2) Si un mensaje dentro del rango especificado de mensajes no existe o contiene un error:

No se crea ningún elemento del array para ese mensaje.
No se devuelve ningún código de error.

3) La imposibilidad de localizar uno o varios encabezados en un mensaje no constituye un error:

Un elemento del array se crea para el mensaje.
Los elementos de los arrays aMsgNum y aMsgId contendrán los valores apropiados.
Para cada encabezado que no existe en el mensaje, se devolverá una cadena vacía en ese elemento del array.
No se devuelve ningún código de error.