Namespace:
Rebex.Net
Assembly:
Rebex.Imap (in Rebex.Imap.dll)
Syntax
Visual Basic |
---|
Public Function BeginCheckForUpdates ( _ duration As Integer, _ callback As AsyncCallback, _ state As Object _ ) As IAsyncResult |
C# |
---|
public IAsyncResult BeginCheckForUpdates( int duration, AsyncCallback callback, Object state ) |
Parameters
- duration
- Type: System..::..Int32
Duration of the idle interval, in milliseconds.
- callback
- Type: System..::..AsyncCallback
An optional asynchronous callback to be called when the operation is complete.
- state
- Type: System..::..Object
A user-provided object that identifies this particular asynchronous operation.
Return Value
An IAsyncResult that references the asynchronous operation.Remarks
Notifications are generated when a new message arrives, when a message is deleted, when message flags change, etc. (see ImapNotification for a list of supported notifications).
These notifications can occur during a call to any Imap method and are reported using the Notification event. The CheckForUpdates(Int32) method is useful when you need to check for any possible changes (reported using notifications) and do not wish to call any other method. Typically, a client application will call CheckForUpdates(Int32) periodically while idle.
To receive the notifications itself, use the Notification event.
This method represents IMAP NOOP or IDLE commands. IDLE is used whenever the server supports this command - see SupportedExtensions property. For duration values less than 10, NOOP is always used.
In builds for .NET 4.0 and higher, this method is available as an extension method. Add 'using Rebex.Legacy' (C#) or 'Import Rebex.Legacy' (VB.NET) to your code in order to use it.