Imap.CheckForUpdatesAsync Method

Namespace: Rebex.Net

Assembly: Rebex.Imap.dll (version 7.0.9147)

CheckForUpdatesAsync(Int32, Object)

Begins asynchronous CheckForUpdates operation. Processes server notifications for the specified amount of time.

Declaration

public Task<bool> CheckForUpdatesAsync(int duration, object state = null)

Parameters

Type	Name	Description
Int32	duration	Duration of the idle interval, in milliseconds.
Object	state	An optional user-provided object that identifies this particular asynchronous operation.

Returns

Type	Description
Task<Boolean>	True if any new notifications were received.

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.

CheckForUpdatesAsync(Object)

Begins asynchronous CheckForUpdates operation. Processes server notifications.

Declaration

public Task<bool> CheckForUpdatesAsync(object state = null)

Parameters

Type	Name	Description
Object	state	An optional user-provided object that identifies this particular asynchronous operation.

Returns

Type	Description
Task<Boolean>	True if any new notifications were received.

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() 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() periodically while idle.

To receive the notifications itself, use the Notification event.

This method represents IMAP NOOP command.