تخطَّ إلى المستندات
CLI

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

الصلاحياتthreads:readيتطلب تسجيل الدخول

الاستخدام

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 preview
Print the raw JSON
openemail exports preview --json

متاح أيضًا في

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

openemail exports list

List the exports

الصلاحياتthreads:readيتطلب تسجيل الدخولأسماء بديلة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 list
Print the raw JSON
openemail exports list --json

متاح أيضًا في

API
GET /exports
SDK
exports.list()

openemail exports get

Retrieve an export

الصلاحياتthreads:readيتطلب تسجيل الدخولأسماء بديلة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 start or list.

أمثلة

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

متاح أيضًا في

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

openemail exports start

Start an export

الصلاحياتthreads:readيتطلب تسجيل الدخول

الاستخدام

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 start
Print the raw JSON
openemail exports start --json

متاح أيضًا في

API
POST /exports
SDK
exports.start()

openemail exports download

Download an export

الصلاحياتthreads:readيتطلب تسجيل الدخول

الاستخدام

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 start or list.

الخيارات

-o, --out <file>

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

أمثلة

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

متاح أيضًا في

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