|
Summary
Requests a checkpoint for the currently selected mailbox.
Syntax
Int Check ()
Description
The Check method requests a checkpoint of the currently selected mailbox.
A checkpoint refers to any implementation-dependent housekeeping associated with the mailbox, for example resolving the server's in-memory state of the mailbox with the state on its disk that is not
normally executed as part of each command. A checkpoint may take a non-instantaneous amount of real time to complete. If the server implementation has no such housekeeping considerations, the Check
method is equivalent to the Noop method.
This method is only valid if a connection has been established, the user has logged in and a mailbox selected. If this method is successful the OnCheck event will be fired to deliver the checkpoint
to the application.
Return Value
If successful the Check method returns IMAP_SUCCESS. If it fails the OnError event will be fired and one of the following error values will be returned:
ERR_IMAP_INVALID_HANDLE
Invalid connection handle. A connection must be established before performing this action.
ERR_IMAP_NOSELECTED_MAILBOX
There is no currently selected mailbox.
ERR_IMAP_FAILURE
Host was not able to execute command.
ERR_IMAP_CANNOT_SEND_COMMAND
Windows Sockets library was not able to accept outgoing data.
ERR_IMAP_TIMED_OUT
Time out occurred while waiting for a response from host.
ERR_IMAP_IN_ACTION
Another operation is already in progress.
ERR_IMAP_ABORTED
Operation was aborted and connection has been closed.
ERR_IMAP_INSUFFICIENT_LENGTH
Insufficient length.
If this method returns ERR_IMAP_FAILURE, then the ImapReply property will contain the error message sent by the host which describes the reason why the command failed.
Example
Result = Imap.Check ()
If (Result != IMAP_SUCCESS) Then
MsgBox "Checkpoint request failed.", 64, "Sample Program"
Exit Sub
End
If
| 
