:GetMessageId()
Class
Syntax
:GetMessageID( nMsgNo, [hSession] ) -> cMessageID
Parameters
|
|
nMsgNo |
Message number to get information about |
|
|
hSession |
Optional: If hSession is not passed, the value in :Session will be used |
Return
Returns the Unique Message ID (UID) for the specified message.
Description
The :GetMessageID() method returns the unique message identifier (UID) for the specified message.
The returned value is a string which can be used to uniquely identify a specific message in the mailbox across multiple client sessions (this is commonly used by mail clients to determine if they have already retrieved a message from the server in a previous session). Because the UID is guaranteed to be unique across messages, it is also frequently used as a key or component of the file name to reference the message after it has been stored on the local system.
See Also
:StoreMessage(), :GetMessage(), :GetHeaderValue(), :GetMessageHeader(), :GetMessageSender()