Specifies the idle monitoring options that the ImapClient class supports.
The Idle method can operate in two modes, based on the options specified by the caller. If the option imapIdleNoWait is specified, the method begins monitoring the client session asynchronously and returns control immediately to the caller. If the server sends a update notification to the client, the OnUpdate event will fire with information about the status change. If the option imapIdleWait is specified, the method will block waiting for the server to send a notification message to the client. The method will return when either a message is received or the timeout period is exceeded.
| Member Name | Description |
|---|---|
| idleNoWait | The Idle method should return immediately after idle processing has been enabled. When this option is used, the application may continue to perform other functions while the client session is monitored for status updates sent by the server. The client will continue to monitor status changes until an IMAP command issued or the client disconnects from the server. This is the default option. |
| idleWait | The Idle method should wait until the server sends a status update, or until the timeout period is reached. The client will stop monitoring status changes when the function returns. If this option is used in a single-threaded application, normal message processing can be impeded, causing the application to appear non-responsive until the timeout period is reached. It is strongly recommended that single-threaded applications with a user interface specify the imapIdleNoWait option instead. |
Namespace: SocketTools
Assembly: SocketTools.ImapClient (in SocketTools.ImapClient.dll)
SocketTools Namespace | Idle Method (SocketTools.ImapClient) | OnUpdate Event (SocketTools.ImapClient)