EmailMailboxServerSearchReadBatchRequest
EmailMailboxServerSearchReadBatchRequest
EmailMailboxServerSearchReadBatchRequest
EmailMailboxServerSearchReadBatchRequest
Class
Definition
Details of a request to read a batch of server-side search results.
public : sealed class EmailMailboxServerSearchReadBatchRequest : IEmailMailboxServerSearchReadBatchRequestpublic sealed class EmailMailboxServerSearchReadBatchRequest : IEmailMailboxServerSearchReadBatchRequestPublic NotInheritable Class EmailMailboxServerSearchReadBatchRequest Implements IEmailMailboxServerSearchReadBatchRequest// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Remarks
Used in your ServerSearchReadBatchRequested event handler. Use the instance of this class that's returned by the EmailMailboxSeverSearchReadBatchRequestEventArgs.Request property.
Properties
EmailFolderId EmailFolderId EmailFolderId EmailFolderId
Gets the folder ID of the folder where the search is to be performed.
public : PlatForm::String EmailFolderId { get; }public string EmailFolderId { get; }Public ReadOnly Property EmailFolderId As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
A folder ID.
EmailMailboxId EmailMailboxId EmailMailboxId EmailMailboxId
Gets the mailbox ID of the mailbox where the search is to be performed.
public : PlatForm::String EmailMailboxId { get; }public string EmailMailboxId { get; }Public ReadOnly Property EmailMailboxId As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
A mailbox ID.
Options Options Options Options
Gets the search options to be applied to this search.
public : EmailQueryOptions Options { get; }public EmailQueryOptions Options { get; }Public ReadOnly Property Options As EmailQueryOptions// You can use this property in JavaScript.
An EmailQueryOptions object specifying the search options.
SessionId SessionId SessionId SessionId
Gets the search session ID of this server-side batch read request.
public : PlatForm::String SessionId { get; }public string SessionId { get; }Public ReadOnly Property SessionId As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
A search session ID.
SuggestedBatchSize SuggestedBatchSize SuggestedBatchSize SuggestedBatchSize
Gets the suggested batch size for the server-side search batch read.
public : unsigned int SuggestedBatchSize { get; }public uint SuggestedBatchSize { get; }Public ReadOnly Property SuggestedBatchSize As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The suggested number of messages in a batch. Clients suggest a batch size based on client-side criteria such as screen real estate, storage capacity, or bandwidth.
Methods
ReportCompletedAsync() ReportCompletedAsync() ReportCompletedAsync() ReportCompletedAsync()
Informs the email client that the request was processed successfully.
public : IAsyncAction ReportCompletedAsync()public IAsyncAction ReportCompletedAsync()Public Function ReportCompletedAsync() As IAsyncAction// You can use this method in JavaScript.
An asynchronous batch read request operation on an EmailMailboxServerSearchReadBatchRequest.
ReportFailedAsync(EmailBatchStatus) ReportFailedAsync(EmailBatchStatus) ReportFailedAsync(EmailBatchStatus) ReportFailedAsync(EmailBatchStatus)
Informs the client that the request was not processed successfully.
public : IAsyncAction ReportFailedAsync(EmailBatchStatus batchStatus)public IAsyncAction ReportFailedAsync(EmailBatchStatus batchStatus)Public Function ReportFailedAsync(batchStatus As EmailBatchStatus) As IAsyncAction// You can use this method in JavaScript.
An EmailBatchStatus value describing the current status of the batch.
An asynchronous batch read request operation on an EmailMailboxServerSearchReadBatchRequest.
SaveMessageAsync(EmailMessage) SaveMessageAsync(EmailMessage) SaveMessageAsync(EmailMessage) SaveMessageAsync(EmailMessage)
Saves a message that meets server-side search criteria.
public : IAsyncAction SaveMessageAsync(EmailMessage message)public IAsyncAction SaveMessageAsync(EmailMessage message)Public Function SaveMessageAsync(message As EmailMessage) As IAsyncAction// You can use this method in JavaScript.
A message that matches the search criteria of a server-side batch read request.
An asynchronous message save operation on an EmailMailboxServerSearchReadBatchRequest.