EwsDownloadFolders Method (FolderId, FolderView, SearchFilter, Boolean) |
Downloads the list of folders of the MS Exchange account.
Namespace: MailBee.EwsMailAssembly: MailBee.NET (in MailBee.NET.dll) Version: 12.5.0 build 687 for .NET 4.5
Syntax public List<EwsFolder> DownloadFolders(
FolderId parentFolderId,
FolderView view,
SearchFilter filter,
bool includeParentFolder
)
Public Function DownloadFolders (
parentFolderId As FolderId,
view As FolderView,
filter As SearchFilter,
includeParentFolder As Boolean
) As List(Of EwsFolder)
Parameters
- parentFolderId
- Type: FolderId
The ID of the folder for which to return folders. If a null reference (Nothing in Visual Basic), RootFolderType value will be used. - view
- Type: FolderView
Managed EWS view object which configures how many folders to return, whether or not to include sub-folders, ordering, etc. If a null reference, MailBee will pass the view
which lists no sub-folders, max item count, normal ordering. - filter
- Type: SearchFilter
Managed EWS filter which configures what kind of folders to return. If a null reference, no filter will be applied and all kinds of folders will be returned. - includeParentFolder
- Type: SystemBoolean
If true, the folder denoted by parentFolderId will be included in the resulting list; otherwise, it won't be there.
Return Value
Type:
ListEwsFolderThe list of folders of the current MS Exchange account under
parentFolderId, if the folder list was downloaded successfully; otherwise, a null reference (
Nothing in Visual Basic).
Exceptions Remarks
This method returns the list of sub-folders of
parentFolderId folder accordingly the specified settings. If you don't need non-email folders, you can pass
MessageFoldersFilter property as
filter value.
See Also