openemail exports
この名前空間のすべてのコマンドと、その引数、フラグ、例。
コマンド
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.
ここのすべてのコマンドは、--json、--profile、--dry-run などのグローバルフラグも受け付けます。 グローバルフラグを見る
openemail exports preview
See what an export would hold
使い方
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.
例
openemail exports previewopenemail exports preview --jsonほかの提供先
openemail exports list
List the exports
ls使い方
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.
フラグ
--limit <n>Exports per page, from 1 to 100. The server defaults to 25.
既定値25--offset <n>How many exports to skip.
既定値0
例
openemail exports listopenemail exports list --jsonほかの提供先
openemail exports get
Retrieve an export
showview使い方
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.
引数
<id>必須The export id from
startorlist.
例
openemail exports get exp_8c1e4a7f2b9d3e6a0c5f1b28openemail exports get exp_8c1e4a7f2b9d3e6a0c5f1b28 --jsonほかの提供先
openemail exports start
Start an export
使い方
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.
例
openemail exports startopenemail exports start --jsonほかの提供先
openemail exports download
Download an export
使い方
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.
引数
<id>必須The export id from
startorlist.
フラグ
-o, --out <file>Write the file here. Required on a terminal. Without it, piped output gets the raw bytes
例
openemail exports download exp_8c1e4a7f2b9d3e6a0c5f1b28openemail exports download exp_8c1e4a7f2b9d3e6a0c5f1b28 --out report.pdf