Export

Create export

Creates a new bulk message export job. The export runs asynchronously and notifies via webhook when complete.<br/><br/>Runs as a background job. Follow it either by polling the status endpoint or by waiting for the completion webhook.

post/v1/account/{account}/export

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/account/{account}/export
  • 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

foldersstring[]

Folder paths or special-use flags (e.g., \Inbox, \Sent, \All) to export from

startDatestring date-time required

Export messages from this date

endDatestring date-time required

Export messages until this date

textType'plain' | 'html' | '*'

Which message bodies to include in the export

maxBytesinteger

Maximum bytes for text content (0 = unlimited)

includeAttachmentsboolean

Include attachment content as base64 blob in attachments array

Example request

{
  "folders": [
    "INBOX"
  ],
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-12-31T23:59:59Z",
  "textType": "*",
  "maxBytes": 5242880
}

Response

Returns the ID of the started export. Poll the status endpoint until it completes.

exportIdstring

Export job identifier

statusstring

Export status

createdstring date-time

When export was created

Example response

{
  "exportId": "exp_abc123def456abc123def456",
  "status": "queued",
  "created": "2024-01-15T10:30:00Z"
}

Changes

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