Zur Dokumentation springen
CLI

openemail exports

Jeder Befehl in diesem Namespace, mit seinen Argumenten, Flags und Beispielen.

Befehle

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.

Jeder Befehl hier nimmt auch die globalen Flags an, etwa --json, --profile und --dry-run. Zu den globalen Flags

openemail exports preview

See what an export would hold

Geltungsbereichethreads:readErfordert eine Anmeldung

Aufruf

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.

Beispiele

openemail exports preview
Print the raw JSON
openemail exports preview --json

Auch verfügbar über

API
GET /exports/preview
SDK
exports.preview()

openemail exports list

List the exports

Geltungsbereichethreads:readErfordert eine AnmeldungAliassels

Aufruf

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.

Standard25
--offset <n>

How many exports to skip.

Standard0

Beispiele

openemail exports list
Print the raw JSON
openemail exports list --json

Auch verfügbar über

API
GET /exports
SDK
exports.list()

openemail exports get

Retrieve an export

Geltungsbereichethreads:readErfordert eine AnmeldungAliasseshowview

Aufruf

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.

Argumente

<id>Erforderlich

The export id from start or list.

Beispiele

openemail exports get exp_8c1e4a7f2b9d3e6a0c5f1b28
Print the raw JSON
openemail exports get exp_8c1e4a7f2b9d3e6a0c5f1b28 --json

Auch verfügbar über

API
GET /exports/{id}
SDK
exports.get()

openemail exports start

Start an export

Geltungsbereichethreads:readErfordert eine Anmeldung

Aufruf

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.

Beispiele

openemail exports start
Print the raw JSON
openemail exports start --json

Auch verfügbar über

API
POST /exports
SDK
exports.start()

openemail exports download

Download an export

Geltungsbereichethreads:readErfordert eine Anmeldung

Aufruf

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.

Argumente

<id>Erforderlich

The export id from start or list.

Flags

-o, --out <file>

Write the file here. Required on a terminal. Without it, piped output gets the raw bytes

Beispiele

openemail exports download exp_8c1e4a7f2b9d3e6a0c5f1b28
Save the file
openemail exports download exp_8c1e4a7f2b9d3e6a0c5f1b28 --out report.pdf

Auch verfügbar über

API
GET /exports/{id}/content
SDK
exports.download()