emailengine-client
Version:
A TypeScript client for the EmailEngine API
46 lines (45 loc) • 1.28 kB
TypeScript
import { SearchQuery } from "../../../../misc/models/SearchQuery";
import { Options } from "../../../../misc/Options";
export declare class SearchMessagesOptions extends Options {
/**
* Override the EENGINE_TIMEOUT environment variable for a single API request (in milliseconds)
*/
'x-ee-timeout'?: number | undefined;
/**
* Account ID
*/
'account': string;
/**
* Mailbox folder path. Not required if documentStore is true
*/
'path'?: string | undefined;
/**
* Page number (zero indexed, so use 0 for first page)
*/
'page'?: number | undefined;
/**
* How many entries per page
*/
'pageSize'?: number | undefined;
/**
* If enabled then fetch the data from the Document Store instead of IMAP
*/
'documentStore'?: boolean | undefined;
/**
* If enabled then returns the ElasticSearch query for debugging as part of the response
*/
'exposeQuery'?: boolean | undefined;
/**
* Search query to filter messages
*/
'body': {
/**
* Search query to filter messages
*/
search: SearchQuery;
/**
* Document Store query. Only allowed with documentStore.
*/
documentQuery?: any;
};
}