API Reference
Class
EmailStoreFolderCatalog
Indexed, cycle-safe navigation over the lightweight folder catalog of one open store.
Inheritance
- Object
- EmailStoreFolderCatalog
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property EmailStoreSession.FolderCatalog
Methods
public EmailStoreFolderInfo FindSpecialFolder(EmailStoreSpecialFolderKind kind) #Returns:
EmailStoreFolderInfoReturns the single matching well-known folder, or null; throws if the role is ambiguous.
Parameters
- kind OfficeIMO.Email.Store.EmailStoreSpecialFolderKind
public IReadOnlyList<EmailStoreFolderInfo> FindSpecialFolders(EmailStoreSpecialFolderKind kind) #Returns:
IReadOnlyList<EmailStoreFolderInfo>Gets every folder classified with the requested well-known role.
Parameters
- kind OfficeIMO.Email.Store.EmailStoreSpecialFolderKind
public EmailStoreFolderInfo Get(EmailStoreFolderId id) #Returns:
EmailStoreFolderInfoGets one folder or throws when the identifier is not in this store.
Parameters
- id OfficeIMO.Email.Store.EmailStoreFolderId
public IReadOnlyList<EmailStoreFolderInfo> GetChildren(EmailStoreFolderId id) #Returns:
IReadOnlyList<EmailStoreFolderInfo>Gets immediate children in source order.
Parameters
- id OfficeIMO.Email.Store.EmailStoreFolderId
public IReadOnlyList<EmailStoreFolderInfo> GetDescendants(EmailStoreFolderId id, Int32 maxFolders = 100000) #Returns:
IReadOnlyList<EmailStoreFolderInfo>Enumerates descendants breadth-first, bounded and protected from source cycles.
Parameters
- id OfficeIMO.Email.Store.EmailStoreFolderId
- maxFolders System.Int32 = 100000
public EmailStoreFolderInfo GetParent(EmailStoreFolderId id) #Returns:
EmailStoreFolderInfoGets the resolvable parent, or null for a root or dangling source parent.
Parameters
- id OfficeIMO.Email.Store.EmailStoreFolderId
public IReadOnlyList<EmailStoreFolderInfo> GetPath(EmailStoreFolderId id, Int32 maxDepth = 1024) #Returns:
IReadOnlyList<EmailStoreFolderInfo>Gets the root-to-folder path, stopping safely if corrupt parent links form a cycle.
Parameters
- id OfficeIMO.Email.Store.EmailStoreFolderId
- maxDepth System.Int32 = 1024
public Boolean TryGet(EmailStoreFolderId id, out EmailStoreFolderInfo folder) #Returns:
BooleanAttempts to get one folder.
Parameters
- id OfficeIMO.Email.Store.EmailStoreFolderId
- folder OfficeIMO.Email.Store.EmailStoreFolderInfo@
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object