4D Doc Center : IMAP

4D v13.2

IMAP_MsgLstInfo


IMAP_MsgLstInfo ( imap_ID ; startMsg ; endMsg ; msgSizeArray ; msgNumArray ; msgIdArray ) -> Function result

Parameter	Type	Description
imap_ID	Longint	Reference to an IMAP login
startMsg	Longint	Start message number
endMsg	Longint	End message number
msgSizeArray	Longint array	Array of sizes
msgNumArray	Longint array	Array of message numbers
msgIdArray	Longint array	Array of Unique Msg IDs
Function result	Integer	Error code

Description

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

The IMAP_MsgLstInfo command will not return an error number if it fails to retrieve information on a message within the current message list. If an error occurs, 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.

imap_ID is a long integer reference to an open connection created with IMAP_Login.

startMsg is a long integer number that 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 current working mailbox.

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 current working mailbox.

Note: The IMAP_Delete, IMAP_MsgLstInfo, IMAP_MsgLst, IMAP_SetFlags, IMAP_GetFlags and IMAP_CopyToMB commands do not return an error if the startMsg is greater than the endMsg. In the event that this occurs, the command – in effect – does nothing.

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.

msgIdArray is a long integer array returning the Unique IDs of the messages between startMsg and endMsg.