IMAP_UIDToMsgNum

Home

4D v20

IMAP_UIDToMsgNum


IMAP_UIDToMsgNum ( imap_ID ; unique_ID ; msgNum ) -> Function result

Parameter	Type	Description
imap_ID	Longint	Reference to an IMAP login
unique_ID	Longint	Message unique identifier value
msgNum	Longint	Message number
Function result	Integer	Error code

Description

The IMAP_UIDToMsgNum command converts a message unique_ID value to its current msgNum within the list of messages in the current mailbox referenced by imap_ID. Since a specific e-mail message msgNum is a floating value relative to other items in the electronic mail list, this command returns the current position of a message whose information may have been retrieved during a prior IMAP session.

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

unique_ID is a long integer value indicating the Unique ID of a message to be located on the IMAP server.

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