Account

Request account flush

Deletes all email indexes from Redis and re-creates the index for that account. You can only run a single flush operation at a time, so you must wait until the previous flush has finished before initiating a new one.<br/><br/>The request only schedules the work and returns before it finishes. Watch the account state, or the accountInitialized and authenticationError webhooks, for the result.

put/v1/account/{account}/flush

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/account/{account}/flush
  • Auth: HTTP bearer

Path parameters

accountstring required

Unique identifier for the email account

Example:user123

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Request body

flushboolean

Only flush the account if true

notifyFromstring date-time nullable

Only send webhooks for messages received after this date. Defaults to account creation time. IMAP only.

imapIndexer'full' | 'fast' nullable

Override the global IMAP indexing strategy for this account

Example request

{
  "notifyFrom": "2021-07-08T07:06:34.336Z",
  "imapIndexer": "full"
}

Response

Returns an acknowledgement. Cached message indexes are cleared and rebuilt in the background.

flushboolean

Flush status

Changes

No recorded changes to this operation across all 1 revision of this API.