POP3_UIDToNum

Home

4D Internet Commands v16

POP3_UIDToNum


POP3_UIDToNum ( pop3_ID ; uniqueID ; msgNumber ) -> Function result

Parameter	Type	Description
pop3_ID	Longint	Reference to a POP3 login
uniqueID	String	Unique ID of message on server
msgNumber	Longint	Message number
Function result	Integer	Error Code

Description

The POP3_UIDToNum command converts a message's Unique ID value to its current msgNumber within the list of messages in the mailbox referenced by pop3_ID. Since a specific mail message's msgNumber is a floating value relative to other items in the mail list, this command returns the current position of a message whose information may have been retrieved during a prior POP3 session.

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

uniqueID is a string value containing the Unique-ID of a message to locate on the POP3 server. This command will look for this value in the message headers of the account referenced by pop3_ID. Once found, the message's current position in the listing will be returned in msgNumber.

msgNumber is a long integer returned containing the current message number (its position within the current message list) of the item identified by uniqueID. If the uniqueID cannot be found on the server, a zero is returned in msgNumber and no error is returned.