IMAP_GetMessage

4D Internet Commands v16

IMAP_GetMessage


IMAP_GetMessage ( imap_ID ; numMsg ; offset ; longitud ; parteMsg ; textoMsg {; actSeen} ) -> resultado

Parámetro	Tipo	Descripción
imap_ID	Entero largo	Referencia de conexión IMAP
numMsg	Entero largo	Número del mensaje
offset	Entero largo	Carácter a partir del cual comenzar la recuperación
longitud	Entero largo	Número de caracteres a reenviar
parteMsg	Entero	0 = Mensaje entero, 1 = Encabezado únicamente, 2 = Cuerpo únicamente
textoMsg	Texto	Texto del mensaje
actSeen	Entero	0 = Actualizar marcador \Seen; 1= No actualizar el marcador \Seen
resultado	Entero	Código de error

Descripción

El comando IMAP_GetMessage devuelve el texto completo del mensaje identificado por msgNum en el buzón actual definido por IMAP_SetCurrentMB. A menos que se especifique lo contrario por el comando IMAP_SetPrefs, se eliminarán los caracteres de salto de línea en el mensaje.

El comando IMAP_GetMessage devuelve todo el mensaje, incluyendo la información del encabezado o únicamente una parte del mensaje (encabezado o cuerpo) en función del valor del parámetro parteMsg.

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. Este número representa la posición de un mensaje dentro de la lista actual de los mensajes. Atención, el numMsg de un mensaje no es un valor estable, difiere de una sesión a otra.

offset es un valor entero largo que indica la posición del caracter a partir del cual comenzar la lectura. En la mayoría de los casos pase cero en este parámetro.

El parámetro longitud es un valor entero largo que indica el número de caracteres a recuperar más allá de la posición offset. Dado que la longitud máxima de una variable de tipo texto 4D está limitada a 32.000 caracteres, el parámetro longitud debe ser inferior a 32.000. Las partes de mensajes a recuperar cuyo tamaño sea mayor que 32 K se deben guardar en el disco mediante el comando IMAP_Download.

parteMsg indica la parte del mensaje a recuperar. Se pueden pasar los valores 0, 1 o 2:

0 = Todo el mensaje,
1 = Sólo el encabezado,
2 = Cuerpo únicamente (es decir a partir del primer Texto/plano encontrado).

Cuando recupera el mensaje entero o el encabezado únicamente, recupera texto bruto no decodificado. Por otra parte, al recuperar sólo el cuerpo, el texto obtenido se decodifica automáticamente y si es necesario se convierte (ver POP3_Charset para obtener más información sobre las reglas de decodificación y conversión).

actSeen es un valor entero que indica si el marcador \Seen debe añadirse o no a los marcadores del mensaje. Este parámetro es opcional y se utiliza el valor por defecto si no se pasa este parámetro.

0 = Añadir el marcador \Seen (valor por defecto);
1= No añadir el marcador \Seen;

textoMsg es una variable texto que recibe el texto recuperado.

Ver también

IMAP_Download
IMAP_Login
IMAP_SetCurrentMB
IMAP_SetPrefs