Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

EmailStoreContentQuery

Namespace OfficeIMO.Email.Store
Assembly OfficeIMO.Email
Source revision 804a7612eee4 with working tree changes
Modifiers sealed

Bounded, resumable query over summary and selected item content.

Inheritance

  • Object
  • EmailStoreContentQuery

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.

Accepted by parameters 1

Constructors

EmailStoreContentQuery 2 overloads
public EmailStoreContentQuery(IEnumerable<String> terms, EmailStoreContentSearchFields fields = All, EmailStoreContentMatchMode matchMode = AllTerms, EmailStoreQuery? metadataFilter = null, Int32 maxItemsScanned = 10000, Int32 maxResults = 100, Int64 maxDecodedPropertyBytesPerItem = 16777216, Int32 maxSearchableCharactersPerItem = 2000000, Int32 snippetCharacters = 240, Int32 progressInterval = 100, Boolean continueOnItemError = true, EmailStoreContentSearchCheckpoint? resumeFrom = null) #

Creates a bounded content query.

Parameters

terms System.Collections.Generic.IEnumerable<System.String> requiredposition: 0
fields OfficeIMO.Email.Store.EmailStoreContentSearchFields = All optionalposition: 1
matchMode OfficeIMO.Email.Store.EmailStoreContentMatchMode = AllTerms optionalposition: 2
metadataFilter OfficeIMO.Email.Store.EmailStoreQuery? = null optionalposition: 3
maxItemsScanned System.Int32 = 10000 optionalposition: 4
maxResults System.Int32 = 100 optionalposition: 5
maxDecodedPropertyBytesPerItem System.Int64 = 16777216 optionalposition: 6
maxSearchableCharactersPerItem System.Int32 = 2000000 optionalposition: 7
snippetCharacters System.Int32 = 240 optionalposition: 8
progressInterval System.Int32 = 100 optionalposition: 9
continueOnItemError System.Boolean = true optionalposition: 10
resumeFrom OfficeIMO.Email.Store.EmailStoreContentSearchCheckpoint? = null optionalposition: 11
public EmailStoreContentQuery(IEnumerable<String> terms, IEmailStoreBodyTextProjector? bodyTextProjector, EmailStoreContentSearchFields fields = All, EmailStoreContentMatchMode matchMode = AllTerms, EmailStoreQuery? metadataFilter = null, Int32 maxItemsScanned = 10000, Int32 maxResults = 100, Int64 maxDecodedPropertyBytesPerItem = 16777216, Int32 maxSearchableCharactersPerItem = 2000000, Int32 snippetCharacters = 240, Int32 progressInterval = 100, Boolean continueOnItemError = true, EmailStoreContentSearchCheckpoint? resumeFrom = null) #

Creates a bounded content query with an optional format-owned body projection.

Parameters

terms System.Collections.Generic.IEnumerable<System.String> requiredposition: 0
bodyTextProjector OfficeIMO.Email.Store.IEmailStoreBodyTextProjector? requiredposition: 1
fields OfficeIMO.Email.Store.EmailStoreContentSearchFields = All optionalposition: 2
matchMode OfficeIMO.Email.Store.EmailStoreContentMatchMode = AllTerms optionalposition: 3
metadataFilter OfficeIMO.Email.Store.EmailStoreQuery? = null optionalposition: 4
maxItemsScanned System.Int32 = 10000 optionalposition: 5
maxResults System.Int32 = 100 optionalposition: 6
maxDecodedPropertyBytesPerItem System.Int64 = 16777216 optionalposition: 7
maxSearchableCharactersPerItem System.Int32 = 2000000 optionalposition: 8
snippetCharacters System.Int32 = 240 optionalposition: 9
progressInterval System.Int32 = 100 optionalposition: 10
continueOnItemError System.Boolean = true optionalposition: 11
resumeFrom OfficeIMO.Email.Store.EmailStoreContentSearchCheckpoint? = null optionalposition: 12

Properties

public IReadOnlyList<String> Terms { get; } #

Case-insensitive terms.

public EmailStoreContentSearchFields Fields { get; } #

Fields searched.

public EmailStoreContentMatchMode MatchMode { get; } #

Term-combination mode.

public EmailStoreQuery? MetadataFilter { get; } #

Optional cheap summary filter evaluated before item content is decoded.

public Int32 MaxItemsScanned { get; } #

Maximum item references processed in this batch.

public Int32 MaxResults { get; } #

Maximum matches returned in this batch.

public Int64 MaxDecodedPropertyBytesPerItem { get; } #

Maximum decoded property bytes allowed for one selective item read.

public Int32 MaxSearchableCharactersPerItem { get; } #

Maximum searchable characters retained across fields of one item.

public Int32 SnippetCharacters { get; } #

Maximum snippet characters.

public Int32 ProgressInterval { get; } #

Scanned-item interval between progress notifications.

public Boolean ContinueOnItemError { get; } #

Whether corrupt or over-limit items are diagnosed and skipped.

public EmailStoreContentSearchCheckpoint? ResumeFrom { get; } #

Optional checkpoint from a previous batch.

public IEmailStoreBodyTextProjector? BodyTextProjector { get; } #

Optional format-owned projection. Null retains the built-in transport-only text extraction.