|
Summary
Requests a listing of capabilities that the server supports.
Syntax
Description
The Capability method requests a listing of all the capabilities that the server supports. This method is used to determine if the IMAP protocol is supported on the server.
If successful the OnCapability event will be fired to deliver the server capability.
Return Value
If successful the Capability 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_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.Capability () If (Result != IMAP_SUCCESS) Then MsgBox "Capability failed.", 64, "Sample Program" End If
|