emailengine-client
Version:
A TypeScript client for the EmailEngine API
49 lines (48 loc) • 1.78 kB
TypeScript
import { Options } from "../../../../misc/Options";
export declare class RequestAuthForm extends Options {
/**
* Override the EENGINE_TIMEOUT environment variable for a single API request (in milliseconds)
*/
'x-ee-timeout'?: number | undefined;
/**
* Request body
*/
'body': {
/**
* Account ID. If the provided value is null then an unique ID will be autogenerated. Using an existing account ID will update settings for that existing account.
*/
'account'?: string;
/**
* Display name for the account
*/
'name'?: string;
/**
* Default email address of the account
*/
'email'?: string;
/**
* If true then acts as a shared mailbox. Available for MS365 OAuth2 accounts.
*/
'delegated'?: boolean;
/**
* Sync messagesto document store starting from provided date. If not set, all emails are synced.
*/
'syncFrom'?: string;
/**
* Send webhooks for messages starting from provided date. The default is the account creation date.
*/
'notifyFrom'?: 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[];
/**
* The user will be redirected to this URL after submitting the authentication form.
*/
'redirectUrl': string;
/**
* Display the form for the specified account type (either "imap" or an OAuth2 app ID) instead of allowing the user to choose
*/
'type'?: string;
};
}