emailengine-client

import { Options } from "../../../../misc/Options"; /** * Set setting values for specific keys */ export declare class SetSettingsValuesOptions extends Options { /** * Override the EENGINE_TIMEOUT environment variable for a single API request (in milliseconds) */ 'x-ee-timeout'?: number | undefined; /** * Set Settings Values Details */ 'body': { /** * If false then do not emit webhooks */ webhooksEnabled?: boolean | undefined; /** * Webhook URL */ webhooks?: string; /** * webhookEvents[string * example: messageNew * maxLength: 256] */ webhookEvents?: string[]; /** * WebhooksCustomHeaders[WebhooksCustomHeader{ * key* string * maxLength: 1024 * value string * default: * maxLength: 10240 * }] */ webhooksCustomHeaders?: { key: string; value?: string; }[]; /** * Notify Headers */ notifyHeaders?: string[]; /** * Base URL of EmailEngine */ serviceUrl?: string; /** * If true, then rewrite html links in sent emails to track opens and clicks */ trackSentMessages?: boolean; /** * If true, then resolve the category tab for incoming emails */ resolveGmailCategories?: boolean; /** * If true, then allow insecure certificates for IMAP/SMTP */ ignoreMailCertErrors?: boolean; /** * If true, then extracts reply text using OpenAI ChatGPT */ generateEmailSummary?: boolean; /** * (deprecated, not used) */ generateRiskAssessment?: boolean; /** * OpenAI API key */ openAiAPIKey?: string; /** * OpenAI API Model */ openAiModel?: string; /** * OpenAI API URL */ openAiAPIUrl?: string; /** * OpenAI API Model for chat */ documentStoreChatModel?: string; /** * OpenAI Temperature */ openAiTemperature?: number; /** * Top-p sampling */ openAiTopP?: number; /** * Prompt to send to LLM for analyzing emails */ openAiPrompt?: string; /** * If true, then generates vector embeddings for the email */ openAiGenerateEmbeddings?: boolean; /** * If true, then send "New Email" webhooks for incoming emails only */ inboxNewOnly?: boolean; /** * HMAC secret for signing public requests */ serviceSecret?: string; /** * URL to fetch authentication data from */ authServer?: string; /** * Is the global proxy enabled or not */ proxyEnabled?: boolean; /** * Proxy URL */ proxyUrl?: string; /** * Hostname to use for the SMTP EHLO/HELO greeting */ smtpEhloName?: string; /** * Include message text in webhook notification */ notifyText?: boolean; /** * Pre-process HTML in webhook notification to be web safe */ notifyWebSafeHtml?: boolean; /** * Include calendar events in webhook notification */ notifyCalendarEvents?: boolean; /** * If true then do not show Gmail account option (deprecated) */ gmailEnabled?: boolean; /** * Gmail OAuth2 Client ID (deprecated) */ gmailClientId?: string; /** * Gmail OAuth2 Client Secret (deprecated) */ gmailClientSecret?: string; /** * Gmail OAuth2 Callback URL (deprecated) */ gmailRedirectUrl?: string; /** * Gmail OAuth2 Extra Scopes (deprecated) */ gmailExtraScopes?: string[]; /** * If true then do not show Outlook account option (deprecated) */ outlookEnabled?: boolean; /** * Outlook OAuth2 Client ID (deprecated) */ outlookClientId?: string; /** * Outlook OAuth2 Client Secret (deprecated) */ outlookClientSecret?: string; /** * Outlook OAuth2 Callback URL (deprecated) */ outlookRedirectUrl?: string; /** * Outlook OAuth2 authority (deprecated) */ outlookAuthority?: "consumers" | "organizations" | "common"; /** * Outlook OAuth2 Extra Scopes (deprecated) */ outlookExtraScopes?: string[]; /** * If true then do not show Mail.ru account option (deprecated) */ mailRuEnabled?: boolean; /** * Mail.ru OAuth2 Client ID (deprecated) */ mailRuClientId?: string; /** * Mail.ru OAuth2 Client Secret (deprecated) */ mailRuClientSecret?: string; /** * Mail.ru OAuth2 Callback URL (deprecated) */ mailRuRedirectUrl?: string; /** * Mail.ru OAuth2 Extra Scopes (deprecated) */ mailRuExtraScopes?: string[]; /** * OAuth2 Service Client ID (deprecated) */ serviceClient?: string; /** * OAuth2 Secret Service Key (deprecated) */ serviceKey?: string; /** * OAuth2 Service Extra Scopes (deprecated) */ serviceExtraScopes?: string[]; /** * LogSettings{ * all boolean * example: false * default: false * Enable logs for all accounts * * maxLogLines integer * default: 10000 * minimum: 0 * maximum: 1000000 * } */ logs?: { /** * Enable logs for all accounts */ all?: boolean; maxLogLines?: number; }; /** * imapStrategystring * How to select local IP address for IMAP connections * * Enum: * [ default, dedicated, random ] */ imapStrategy?: string; /** * smtpStrategystring * How to select local IP address for SMTP connections * * Enum: * [ default, dedicated, random ] */ smtpStrategy?: string; /** * x-constraint: OrderedMap { "single": true } * A list of pooled local IP addresses that can be used for IMAP and SMTP connections */ localAddresses?: string[]; /** * Enable SMTP Interface */ smtpServerEnabled?: boolean; /** * SMTP Interface Port */ smtpServerPort?: number; /** * SMTP Host to bind to */ smtpServerHost?: string; /** * Enable PROXY Protocol for SMTP server */ smtpServerProxy?: boolean; /** * Enable SMTP authentication */ smtpServerAuthEnabled?: boolean; /** * SMTP client password. Set to null to disable. */ smtpServerPassword?: string; /** * Enable TLS for the SMTP interface. Requires a valid certificate. */ smtpServerTLSEnabled?: boolean; /** * Enable IMAP Proxy Interface */ imapProxyServerEnabled?: boolean; /** * IMAP Proxy Interface Port */ imapProxyServerPort?: number; /** * IMAP Proxy Host to bind to */ imapProxyServerHost?: string; /** * Enable PROXY Protocol for the IMAP proxy server */ imapProxyServerProxy?: boolean; /** * IMAP proxy client password. Set to null to disable. */ imapProxyServerPassword?: string; /** * Enable TLS for the IMAP proxy interface. Requires a valid certificate. */ imapProxyServerTLSEnabled?: boolean; /** * How many completed or failed queue entries to keep */ queueKeep?: number; /** * How many times to retry an email sending before it is considered as failing */ deliveryAttempts?: number; /** * HTML code displayed on the top of public pages like the hosted authentication form */ templateHeader?: string; /** * JSON object to be used as the env variable in pre-processing scripts */ scriptEnv?: string; /** * Enable support for reverse proxies */ enableApiProxy?: boolean; /** * Enable Document Store syncing */ documentStoreEnabled?: boolean; /** * Document Store URL */ documentStoreUrl?: string; /** * Document Store index name */ documentStoreIndex?: string; /** * Enable Document Store authentication */ documentStoreAuthEnabled?: boolean; /** * Document Store username */ documentStoreUsername?: string; /** * Document Store password */ documentStorePassword?: string; /** * If true, then generates vector embeddings for the email and stores these in the Document Store */ documentStoreGenerateEmbeddings?: boolean; /** * Enable Document Store pre-processing */ documentStorePreProcessingEnabled?: boolean; /** * Default locale identifier * * Enum: * [ en, et, fr, de, ja ] */ locale?: string; /** * Default timezone identifier */ timezone?: string; /** * Filter function for LLM pre-processing (JavaScript) */ openAiPreProcessingFn?: string; /** * Filter function for Document Store pre-processing (JavaScript) */ documentStorePreProcessingFn?: string; /** * Mapping function for Document Store pre-processing (JavaScript) */ documentStorePreProcessingMap?: string; }; }