| INT WINAPI PopGetMessageUid(
|
| |
HCLIENT hClient, |
|
| |
UINT nMessageId, |
|
| |
LPTSTR lpszMessageUID, |
|
| |
INT nMaxLength |
|
| );
|
The PopGetMessageUid function returns the unique
identifier (UID) for the specified message in the current
mailbox.
Parameters
- hClient
- Handle to the client session.
- nMessageId
- Number of message to retrieve the unique identifier for. This
value must be greater than zero. The first message in the mailbox
is message number one.
- lpszMessageUID
- Address of a string buffer to receive the unique identifier for
the specified message. This should be at least 64 bytes in
length.
- nMaxLength
- The maximum length of the string buffer for the message
UID.
Return Value
If the function succeeds, it returns a non-zero value. If no
unique identifier is assigned to the message, the function will
return zero. If an error occurs, the function returns POP_ERROR. To
get extended error information, call PopGetLastError.
Remarks
The PopGetMessageUid function returns the unique message
identifier 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. The UID can also be
used as a key or component of the file name to reference the
message after it has been stored on the local system.
Requirements
Client: Requires Windows 7, Windows Vista or Windows
XP.
Server: Requires Windows Server 2008 or Windows Server
2003.
Header: Include cstools7.h.
Library: Use cspopav7.lib.
See Also
PopGetHeaderValue, PopGetMessage, PopGetMessageHeaders, PopGetMessageId, PopGetMessageSender
|