Imap FolderCheck Async Method
Asynchronously force the server to sync its in-memory state with its disk state.
Definition
Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
An awaitable task.
IMailFolderCheckAsync(CancellationToken)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override Task CheckAsync(
CancellationToken cancellationToken = default
)Parameters
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Return Value
TaskAn awaitable task.
Implements
IMailFolderCheckAsync(CancellationToken)IMailFolderCheckAsync(CancellationToken)
Remarks
The CHECK command forces the IMAP server to sync its in-memory state with its disk state.
For more information about the CHECK command, see rfc3501.
Since the CHECK command was removed in IMAP4rev2, the NOOP command is sent instead when IMAP4rev2 is in use (as recommended by rfc9051).
Exceptions
| ObjectDisposedException | The ImapClient has been disposed. |
| FolderNotOpenException | The ImapFolder is not currently open. |
| ServiceNotConnectedException | The ImapClient is not connected. |
| ServiceNotAuthenticatedException | The ImapClient is not authenticated. |
| OperationCanceledException | The operation was canceled via the cancellation token. |
| IOException | An I/O error occurred. |
| ImapProtocolException | The server's response contained unexpected tokens. |
| ImapCommandException | The server replied with a NO or BAD response. |