API Reference
Class
EmailStoreEnumerationOptions
Controls bounded lightweight item enumeration from an open store.
Inheritance
- Object
- EmailStoreEnumerationOptions
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
Accepted by parameters
Constructors
public EmailStoreEnumerationOptions(String folderId = null, Boolean includeDescendants = false, Boolean includeAssociatedItems = false, Boolean includeOrphanedItems = false, Int32 maxItems = 2147483647, Boolean includeRegularItems = true) #Creates item-enumeration options.
Parameters
- folderId System.String = null
- includeDescendants System.Boolean = false
- includeAssociatedItems System.Boolean = false
- includeOrphanedItems System.Boolean = false
- maxItems System.Int32 = 2147483647
- includeRegularItems System.Boolean = true
Methods
public static EmailStoreEnumerationOptions ForAssociated(Nullable<EmailStoreFolderId> folderId = null, Boolean includeDescendants = false, Int32 maxItems = 2147483647) #Returns:
EmailStoreEnumerationOptionsCreates an associated-information-only scope without scanning normal item tables.
Parameters
- folderId System.Nullable{OfficeIMO.Email.Store.EmailStoreFolderId} = null
- includeDescendants System.Boolean = false
- maxItems System.Int32 = 2147483647
public static EmailStoreEnumerationOptions ForFolder(EmailStoreFolderId folderId, Boolean includeDescendants = false, Boolean includeAssociatedItems = false, Int32 maxItems = 2147483647) #Returns:
EmailStoreEnumerationOptionsCreates options for one typed folder scope.
Parameters
- folderId OfficeIMO.Email.Store.EmailStoreFolderId
- includeDescendants System.Boolean = false
- includeAssociatedItems System.Boolean = false
- maxItems System.Int32 = 2147483647
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public String FolderId { get; } #Optional folder identifier. Null enumerates every folder.
public Boolean IncludeDescendants { get; } #Whether descendants of FolderId are included.
public Boolean IncludeAssociatedItems { get; } #Whether folder-associated information items are included.
public Boolean IncludeOrphanedItems { get; } #Whether items missing from folder contents tables are recovered from source indexes.
public Int32 MaxItems { get; } #Maximum references returned by one enumeration.
public Boolean IncludeRegularItems { get; } #Whether normal folder contents are included.