ImapExamineAsync(FolderInfo, CancellationToken) Method

Selects specified folder (mailbox) as the current read-only folder so that messages inside can be accessed. Examine command will not reset the Recent flag.

Namespace: Limilabs.Client.IMAP
Assembly: Mail (in Mail.dll) Version: 3.0.26106.1555

Syntax

C++

Copy

public Task<FolderStatus> ExamineAsync(
	FolderInfo folder,
	CancellationToken cancel = default
)

Public Function ExamineAsync ( 
	folder As FolderInfo,
	Optional cancel As CancellationToken = Nothing
) As Task(Of FolderStatus)

public:
Task<FolderStatus^>^ ExamineAsync(
	FolderInfo^ folder, 
	CancellationToken cancel = CancellationToken()
)

member ExamineAsync : 
        folder : FolderInfo * 
        ?cancel : CancellationToken 
(* Defaults:
        let _cancel = defaultArg cancel new CancellationToken()
*)
-> Task<FolderStatus>

Parameters

folder FolderInfo: Folder name.
cancel CancellationToken (Optional): A cancellation token that can be used to signal the asynchronous operation should be canceled.

Return Value

TaskFolderStatus
Status of the folder (mailbox).

Remarks

If folder.Flags contain XInbox this method invokes ExamineInbox.

Reference

Imap Class

ExamineAsync Overload

Limilabs.Client.IMAP Namespace