4D Doc Center : POP3

Home

4D Internet Commands v14

POP3_MsgLst


POP3_MsgLst ( pop3_ID ; start ; end ; hdrArray ; msgNumArray ; idArray ; valueArray ) -> Function result

Parameter	Type	Description
pop3_ID	Longint	Reference to a POP3 login
start	Longint	Start message number
end	Longint	End message number
hdrArray	String array	Array of Headers to retrieve
msgNumArray	Longint array	Array of message numbers
idArray	String array	String array of Unique ID's
valueArray	2D String array, 2D Text array	2D Array of header values
Function result	Integer	Error Code

Description

The POP3_MsgLst command is used to get specific information of mailbox contents. hdrArray is a string or text array which lists the specific mail headers you wish to retrieve. valueArray is a 2-dimensional array which receives the data for each header specified in hdrArray. Each requested header will have a corresponding array in the first dimension of valueArray.

This command allows the user to request specific columns of the message list. This command can only return values of header items, it cannot be used to retrieve the body of a message.

Note: Since mail headers can include extended characters, you can automate their management using the POP3_Charset command.

Example

 aHeaders{1}:="Date:"

 aHeaders{2}:="From:"

 aHeaders{3}:="Subject:"

 POP3_MsgLst(◊POP3_ID;vStart;vEnd;aHeaders;aMsgNum;aUIDs;aValues)

 aValues{1}{1}may equal"Thu, 19 November 1998 00:24:02 -0800"

 aValues{2}{1}may equal"Jack@4d.com"

 aValues{3}{1}may equal"Call your wife"

Errors are handled in the following manner:

1) Only communication-related error codes will be returned. If the command can't complete its task because of an error (network, syntax, server, etc.) then the appropriate error code will be returned.

2) If a message within the specified range of messages does not exist or gets an error:
-- No array element is created for that message.
-- No error code will be returned

3) The inability to locate any or all of the specified headers within any message does not constitute an error:
-- An array element for the message will be created
-- The Message Number and UniqueID array element will contain the appropriate values
-- For each header which does not exist in the message, a null string will be returned into that array element
-- No error code will be returned

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.