| INT CheckMailbox( |
| |
UINT *lpnMessages, |
|
| |
UINT *lpnUnseen |
|
| ); |
The CheckMailbox method requests that the server create a
checkpoint of the currently selected mailbox, and returns the current
number of messages and unseen messages.
Parameters
- lpnMessages
- A pointer to an unsigned integer value which will contain the
number of messages in the currently selected mailbox when the
method returns.
- lpnUnseen
- A pointer to an unsigned integer value which will contain the
number of unseen messages in the currently selected mailbox.
Return Value
If the method succeeds, it returns zero. If an error occurs, the
method returns IMAP_ERROR. To get extended error information, call
GetLastError.
Remarks
When the client requests a checkpoint, the server may perform
implementation-dependent housekeeping for that mailbox, such updating
the mailbox on disk with the current state of the mailbox in memory.
On some systems this command has no effect other than to update the
client with the current number of messages in the mailbox.
This method actually sends two IMAP commands. The first is the
CHECK command, followed by the NOOP command to poll for any new
messages that have arrived. In addition to polling the server for new
messages, this command can also be used to ensure the idle timer on
the server does not expire and force a disconnect from the
client.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: csmapv10.lib
See Also
CreateMailbox,
GetFirstMailbox,
GetMailboxStatus,
GetNextMailbox,
RenameMailbox
|