ImapExamineAsync(String, 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(
	string folder,
	CancellationToken cancel = default
)

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

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

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

Parameters

folder String: 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

IMAP servers may differ in the separator character used in folder hierarchy paths. Common separator chars are '.' and '/'. For example: "Inbox/Folder" or "Inbox.Folder".

Reference

Imap Class

ExamineAsync Overload

Limilabs.Client.IMAP Namespace