POP3_MsgLstInfo

Home

4D Internet Commands v16

POP3_MsgLstInfo


POP3_MsgLstInfo ( pop3_ID ; startMsg ; endMsg ; sizeArray ; msgNumArray ; idArray ) -> Function result

Parameter	Type	Description
pop3_ID	Longint	Reference to a POP3 login
startMsg	Longint	Start message number
endMsg	Longint	End message number
sizeArray	Longint array	Array of sizes
msgNumArray	Longint array	Array of message numbers
idArray	String array	Array of Unique ID's
Function result	Integer	Error Code

Description

The POP3_MsgLstInfo command returns information about a set of messages in a mailbox. The information is returned into three arrays with each element of the arrays corresponding to one message. Information is returned about the size of each message, the message number, and the Unique-ID of the message. The arrays passed as parameters must be of pre-declared types, though they may be of any size. The POP3_MsgLstInfo command will reset the size of each array to number of messages retrieved.

The POP3_MsgLstInfo command will not return an error number if it fails to retrieve information on any message within the current message list. If an error is encountered, no element is created in the arrays for the problem message. If the command reads each message successfully, the msgNumArray should contain numeric values in a sequential order. If problems were encountered, there may be gaps in the sequence of numbers held in msgNumArray.

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

startMsg is a long integer number which specifies the starting message number of the message range to be examined. The message number is a value representing the position of a message within the list of all messages in the mailbox identified by pop3_ID.

endMsg is a long integer number which specifies the ending message number of the message range to be examined. The message number is a value representing the position of a message within the list of all messages in the mailbox identified by pop3_ID.

sizeArray is a long integer array returned containing the sizes of each message between startMsg and endMsg.

msgNumArray is a long integer array returned containing the message numbers between startMsg and endMsg.

idArray is a string or text array returned containing the Unique-ID's of the messages between startMsg and endMsg.

Note: The POP3_Delete, POP3_MsgLstInfo and POP3_MsgLst commands do not return an error if the startMsg is greater than the endMsg. In the event that this occurs, this command – in effect – does nothing.