emailengine-client
Version:
A TypeScript client for the EmailEngine API
84 lines (83 loc) • 2.39 kB
TypeScript
import { Options } from "../../../../misc/Options";
import { ImapConfiguration } from "../../../../misc/models/ImapConfiguration";
import { OAuth2 } from "../../../../misc/models/OAuth2";
import { SmtpConfiguration } from "../../../../misc/models/SmtpConfiguration";
export declare class UpdateAccountOptions extends Options {
/**
* Override the EENGINE_TIMEOUT environment variable for a single API request (in milliseconds)
*/
'x-ee-timeout'?: number | undefined;
/**
* Account ID
*/
'account': string;
/**
* Request Body
*/
'body': {
/**
* Display name for the account
*/
'name'?: string;
/**
* Default email address of the account
*/
'email'?: string;
/**
* Check changes only on selected path
*/
'path'?: string;
/**
* An array of mailbox paths. If set, then EmailEngine opens additional IMAP connections against these paths to detect changes faster. NB! connection counts are usually highly limited.
*/
'subconnections'?: string[];
/**
* Account-specific webhook URL
*/
'webhooks'?: string;
/**
* Copy submitted messages to Sent folder. Set to null to unset and use provider specific default.
*/
'copy'?: boolean;
/**
* Store recent logs
*/
'logs'?: boolean;
/**
* Send webhooks for messages starting from provided date. The default is the account creation date.
*/
'notifyFrom'?: string;
/**
* Sync messages to document store starting from provided date. If not set, all emails are synced.
*/
'syncFrom'?: string;
/**
* Proxy URL
*/
'proxy'?: string;
/**
* Hostname to use for the SMTP EHLO/HELO greeting
*/
'smtpEhloName'?: string;
/**
* IMAP Configuration
*/
'imap'?: ImapConfiguration;
/**
* SMTP Configuration
*/
'smtp'?: SmtpConfiguration;
/**
* OAuth2 configuration
*/
'oauth2'?: OAuth2;
/**
* Optional locale
*/
'locale'?: string;
/**
* Optional timezone
*/
'tz'?: string;
};
}