Command IMAP_MsgInfo

4D Internet Commands

IMAP_MsgInfo

version 6.8.1


IMAP_MsgInfo (imap_ID; msgNum; msgSize; uniqueID) Integer

ParameterTypeDescription
imap_IDLongintReference to an IMAP login
msgNumLongintMessage number
msgSizeLongintMessage size
uniqueIDLongintUnique ID of message on server

Function result Integer Error code

Description

The IMAP_MsgInfo command returns information about the message identified by msgNum within the currently selected mailbox. Information about the size of the message and its Unique ID will be returned.

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

msgNum is a long integer value indicating which message in the mailbox you wish to retrieve information about. The msgNum represents the position of a message within the current list of messages. You cannot rely on the msgNum to remain the same for a specific e-mail item from session to session.

msgSize is the long integer value returned containing the message size referenced by msgNum.

uniqueID is a long integer variable denoting the Unique ID of the message on the server. The uniqueID is a value assigned to the message by the IMAP4 server software. This value will not change from session to session in the same way as msgNum. The uniqueID value is a good reference to verify if your database has already downloaded a message from the server

See Also

IMAP_Login, IMAP_SetCurrentMB.