Begins asynchronous GetFolderList operation. Gets the list of subfolders in the specified folder.

Namespace:  Rebex.Net
Assembly:  Rebex.Imap (in Rebex.Imap.dll)

Syntax

Visual Basic
Public Function BeginGetFolderList ( _
	folder As String, _
	mode As ImapFolderListMode, _
	recursive As Boolean, _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult
C#
public IAsyncResult BeginGetFolderList(
	string folder,
	ImapFolderListMode mode,
	bool recursive,
	AsyncCallback callback,
	Object state
)

Parameters

folder
Type: System..::..String
The path to folder for which a list of subfolders is returned.
mode
Type: Rebex.Net..::..ImapFolderListMode
List mode that specifies whether to return all folders or subscribed only.
recursive
Type: System..::..Boolean
Specifies whether to return the whole subfolder tree.
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

To subscribe and unsubscribe to folders, use Subscribe(String) and Unsubscribe(String) methods.

To get a list of root subfolders, use an empty string for folder.

This method represents IMAP LIST and LSUB commands.

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.

Version Information

.NET Compact Framework

Supported in: 3.9, 3.5

See Also