Imap.GetFolderListAsync Method
Namespace: Rebex.Net
Assembly: Rebex.Imap.dll (version 7.0.9083)
GetFolderListAsync(String, ImapFolderListMode, Boolean, Object)
Begins asynchronous GetFolderList operation. Gets the list of subfolders in the specified folder.
Declaration
public Task<ImapFolderCollection> GetFolderListAsync(string folder, ImapFolderListMode mode, bool recursive, object state = null)Parameters
| Type | Name | Description |
|---|---|---|
| String | folder | The path to folder for which a list of subfolders is returned. |
| ImapFolderListMode | mode | List mode that specifies whether to return all folders or subscribed only. |
| Boolean | recursive | Specifies whether to return the whole subfolder tree. |
| Object | state | An optional user-provided object that identifies this particular asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<ImapFolderCollection> | A list of subfolders. |
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.