Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 606 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

EmailStoreFolderCatalog

Edit on GitHub
Namespace OfficeIMO.Email.Store
Assembly OfficeIMO.Email
Source revision 804a7612eee4 with working tree changes
Source EmailStoreFolderCatalog.cs:49
Modifiers sealed

Indexed, cycle-safe navigation over the lightweight folder catalog of one open store.

Inheritance

  • Object
  • EmailStoreFolderCatalog

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Methods

public EmailStoreFolderInfo? FindSpecialFolder(EmailStoreSpecialFolderKind kind) #
EmailStoreFolderCatalog.cs:124
Returns: EmailStoreFolderInfo?

Returns the single matching well-known folder, or null; throws if the role is ambiguous.

Parameters

kind OfficeIMO.Email.Store.EmailStoreSpecialFolderKind requiredposition: 0
public IReadOnlyList<EmailStoreFolderInfo> FindSpecialFolders(EmailStoreSpecialFolderKind kind) #
EmailStoreFolderCatalog.cs:120
Returns: IReadOnlyList<EmailStoreFolderInfo>

Gets every folder classified with the requested well-known role.

Parameters

kind OfficeIMO.Email.Store.EmailStoreSpecialFolderKind requiredposition: 0
public EmailStoreFolderInfo Get(EmailStoreFolderId id) #
EmailStoreFolderCatalog.cs:49
Returns: EmailStoreFolderInfo

Gets one folder or throws when the identifier is not in this store.

Parameters

id OfficeIMO.Email.Store.EmailStoreFolderId requiredposition: 0
public IReadOnlyList<EmailStoreFolderInfo> GetChildren(EmailStoreFolderId id) #
EmailStoreFolderCatalog.cs:68
Returns: IReadOnlyList<EmailStoreFolderInfo>

Gets immediate children in source order.

Parameters

id OfficeIMO.Email.Store.EmailStoreFolderId requiredposition: 0
public IReadOnlyList<EmailStoreFolderInfo> GetDescendants(EmailStoreFolderId id, Int32 maxFolders = 100000) #
EmailStoreFolderCatalog.cs:76
Returns: IReadOnlyList<EmailStoreFolderInfo>

Enumerates descendants breadth-first, bounded and protected from source cycles.

Parameters

id OfficeIMO.Email.Store.EmailStoreFolderId requiredposition: 0
maxFolders System.Int32 = 100000 optionalposition: 1
public EmailStoreFolderInfo? GetParent(EmailStoreFolderId id) #
EmailStoreFolderCatalog.cs:60
Returns: EmailStoreFolderInfo?

Gets the resolvable parent, or null for a root or dangling source parent.

Parameters

id OfficeIMO.Email.Store.EmailStoreFolderId requiredposition: 0
public IReadOnlyList<EmailStoreFolderInfo> GetPath(EmailStoreFolderId id, Int32 maxDepth = 1024) #
EmailStoreFolderCatalog.cs:98
Returns: IReadOnlyList<EmailStoreFolderInfo>

Gets the root-to-folder path, stopping safely if corrupt parent links form a cycle.

Parameters

id OfficeIMO.Email.Store.EmailStoreFolderId requiredposition: 0
maxDepth System.Int32 = 1024 optionalposition: 1
public Boolean TryGet(EmailStoreFolderId id, out EmailStoreFolderInfo? folder) #
EmailStoreFolderCatalog.cs:56
Returns: Boolean

Attempts to get one folder.

Parameters

id OfficeIMO.Email.Store.EmailStoreFolderId requiredposition: 0
folder OfficeIMO.Email.Store.EmailStoreFolderInfo? requiredposition: 1

Properties

public IReadOnlyList<EmailStoreFolderInfo> All { get; } #
EmailStoreFolderCatalog.cs:42

Every folder in source order.

public IReadOnlyList<EmailStoreFolderInfo> Roots { get; } #
EmailStoreFolderCatalog.cs:45

Folders without a resolvable parent.