emailengine-client
Version:
A TypeScript client for the EmailEngine API
44 lines (43 loc) • 1.41 kB
TypeScript
import { Options } from "../../../../misc/Options";
export declare class GetMessageInformationOptions extends Options {
/**
* Override the EENGINE_TIMEOUT environment variable for a single API request (in milliseconds)
*/
'x-ee-timeout'?: number | undefined;
/**
* Account ID
*/
'account': string;
/**
* Message ID
*/
'message': string;
/**
* Max length of text content. This setting is ignored if documentStore is true.
*/
'maxBytes'?: number | undefined;
/**
* Which text content to return, use * for all. By default text content is not returned.
*/
'textType'?: string | undefined;
/**
* Shorthand option to fetch and preprocess HTML and inlined images. Overrides textType, preProcessHtml, and preProcessHtml options.
*/
'webSafeHtml'?: boolean | undefined;
/**
* If true, then fetches attached images and embeds these in the HTML as data URIs
*/
'embedAttachedImages'?: boolean | undefined;
/**
* If true, then pre-processes HTML for compatibility
*/
'preProcessHtml'?: boolean | undefined;
/**
* If true, then marks unseen email as seen while returning the message
*/
'markAsSeen'?: boolean | undefined;
/**
* If enabled then fetch the data from the Document Store instead of IMAP
*/
'documentStore'?: boolean | undefined;
}