openemail exports
Every command in this namespace, with its arguments, flags and examples.
Commands
A zip of the whole workspace, as the Export page makes it: see what it would hold, start one, follow it while it is made and download it once it is ready.
Every command here also takes the global flags, such as --json, --profile and --dry-run. See the global flags
openemail exports preview
See what an export would hold
Usage
openemail exports preview [flags]
Resolves whether the workspace can be exported by the caller now, when the next export can start, the export still being made, if there is one, and how much an export would hold: conversations, attachments and their size, contacts, audiences, calendar events, templates, rules, labels, notes and addresses. When allowed is false, reason says why and counts is null.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an access token connected with every address. A key or token limited to particular addresses or domains is 422 capability_unsupported, and an account the workspace cannot export for is 403 export_not_permitted.
Examples
openemail exports previewopenemail exports preview --jsonAlso available in
openemail exports list
List the exports
lsUsage
openemail exports list [flags]
Resolves every export of the workspace, newest first, a page at a time, with its status, its progress through the conversations and, once it is ready, its size, file name and when it is deleted.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an access token connected with every address. A key or token limited to particular addresses or domains is 422 capability_unsupported, and an account the workspace cannot export for is 403 export_not_permitted.
Flags
--limit <n>Exports per page, from 1 to 100. The server defaults to 25.
Default25--offset <n>How many exports to skip.
Default0
Examples
openemail exports listopenemail exports list --jsonAlso available in
openemail exports get
Retrieve an export
showviewUsage
openemail exports get <id> [flags]
Resolves one export: its status, phase and progress while it is made, and once it is ready its size, file name and when it is deleted.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an access token connected with every address. A key or token limited to particular addresses or domains is 422 capability_unsupported, and an account the workspace cannot export for is 403 export_not_permitted.
Arguments
<id>RequiredThe export id from
startorlist.
Examples
openemail exports get exp_8c1e4a7f2b9d3e6a0c5f1b28openemail exports get exp_8c1e4a7f2b9d3e6a0c5f1b28 --jsonAlso available in
openemail exports start
Start an export
Usage
openemail exports start [flags]
Starts making a zip of the whole workspace, as Export now on the Export page does, and resolves with the export, queued. It is made in the background: poll get until status is ready, then download it. One export runs at a time, and a workspace can be exported once a day.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an access token connected with every address. A key or token limited to particular addresses or domains is 422 capability_unsupported, and an account the workspace cannot export for is 403 export_not_permitted.
Examples
openemail exports startopenemail exports start --jsonAlso available in
openemail exports download
Download an export
Usage
openemail exports download <id> [flags]
Resolves with the zip of a ready export, the same file the Download action on the Export page saves.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an access token connected with every address. A key or token limited to particular addresses or domains is 422 capability_unsupported, and an account the workspace cannot export for is 403 export_not_permitted.
Arguments
<id>RequiredThe export id from
startorlist.
Flags
-o, --out <file>Write the file here. Required on a terminal. Without it, piped output gets the raw bytes
Examples
openemail exports download exp_8c1e4a7f2b9d3e6a0c5f1b28openemail exports download exp_8c1e4a7f2b9d3e6a0c5f1b28 --out report.pdf