4D Doc Center : POP3

Home

4D Internet Commands v14

POP3_GetMessage


POP3_GetMessage ( pop3_ID ; msgNumber ; offset ; length ; msgText ) -> Function result

Parameter	Type	Description
pop3_ID	Longint	Reference to a POP3 login
msgNumber	Longint	Message number
offset	Longint	Offset of character at which to begin retrieval
length	Longint	How many characters to return
msgText	Text	Message Text
Function result	Integer	Error Code

Description

The POP3_GetMessage command returns the complete text of the message identified by msgNumber within the mailbox referenced by pop3_ID. Unless otherwise specified by the POP3_SetPrefs command, any linefeed characters within the message will be removed. The POP3_GetMessage command returns the entire block of the message, including header information.

pop3_ID is a long integer reference to an open session created with POP3_Login.

msgNumber is a long integer value indicating which message in the mailbox to retrieve. The msgNumber represents the position of a message within the current list of messages. You cannot rely on the msgNumber remaining the same for a specific e-mail item from session to session.

offset is a long integer value indicating the number of characters from the beginning of the message to begin reading. In most circumstances a zero should be passed to this parameter.

length is a long integer value representing the number of characters beyond the offset position to retrieve. Since the maximum length of this parameter is limited to 32,000 characters for historical reasons, the length parameter should be set to any number below 32,000. Messages whose size is greater than 32K must be retrieved to disk via the POP3_Download command.

msgText is a text variable which will receive the retrieved text.