エクスポート
このグループのすべてのオペレーションの、受け付ける内容、返す内容、返しうるエラー。
オペレーション
A zip of the whole workspace, as the Export page of the app makes it: every conversation as mbox files with its attachments, contacts as vCard, audiences, calendar events as .ics, templates with every version, rules, labels, notes and addresses. An export is made in the background, can be started once a day and is kept for 365 days.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
GET/exports/preview
See what an export would hold
Whether this 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. 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 app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
戻り値
What an export would hold, and whether one can start.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
GET/exports
List the exports
Every export of the workspace, newest first, with its status and progress. limit and offset page through them, and total counts them all.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
クエリパラメーター
limitintegerExports per page, 1 to 100.
1以上100以下既定値25offsetintegerHow many exports to skip.
0以上既定値0
戻り値
A page of exports, newest first.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
POST/exports
Start an export
Starts making a zip of the whole workspace, as Export now on the Export page does. It is made in the background: read it with GET /exports/{id} until status is ready, then download it. One export can run 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 app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
戻り値
The export, queued.
エラー
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
already_running: an export of this workspace is already being made.- 429
export_limit_reached: the workspace was exported in the last day.
どのオペレーションも返しうるエラー400401404422500エラー一覧
ほかの提供先
GET/exports/{id}
Retrieve an export
One export, 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 app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
パスパラメーター
idstring必須The export id from
GET /exportsorPOST /exports.
戻り値
The export.
エラー
どのオペレーションも返しうるエラー400401403404422500エラー一覧
ほかの提供先
GET/exports/{id}/content
Download an export
The zip itself, as application/zip with its file name in Content-Disposition. It is only there once the export is ready: before that the call is a 409 export_not_ready, and an export older than 365 days is a 409 expired.
Only the workspace owner, or a member whose role holds every permission, can export the workspace: an API key, or an app connected with every address. A key or an app limited to particular addresses or domains is a 422 capability_unsupported, and an account the workspace cannot export for is a 403 export_not_permitted.
Requires the threads:read scope.
パスパラメーター
idstring必須The export id from
GET /exportsorPOST /exports.
戻り値
application/zipThe zip.
エラー
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
export_not_ready: the export is still being made or failed.expired: it was deleted a year after it was made.
どのオペレーションも返しうるエラー400401404422500エラー一覧
ほかの提供先
オブジェクト
Exportobject
objectstring必須- 次のいずれか
"export" idstring必須statusstring必須- 次のいずれか
"queued""running""ready""failed""expired" phasestringWhat it is doing while
statusisrunning.null も可次のいずれか"planning""mail""records""finishing"createdAtstring必須- 形式
date-time createdByobjectWho started it, or null when that account is gone.
null も可namestring- null も可
emailstring
startedAtstring- null も可形式
date-time finishedAtstring- null も可形式
date-time expiresAtstringWhen the zip is deleted, a year after it was made.
null も可形式date-timesizeBytesinteger- null も可
fileNamestring- null も可
threadsDoneinteger- 0以上
threadsTotalinteger- null も可
errorstringWhy it failed, when
statusisfailed.null も可
ExportListobject
objectstring- 次のいずれか
"list" dataExport[]totalintegerHow many exports there are in all.
0以上hasMorebooleanWhether more exports follow this page.
ExportPreviewobject
objectstring必須- 次のいずれか
"export_preview" allowedboolean必須Whether the caller may export this workspace.
reasonstring必須Why not, when
allowedis false:not-permittedfor an account that is neither the owner nor holds every permission,mailbox-loginfor a sign-in for one address, andtwo-factor-requiredwhen the workspace requires two-factor sign-in and the account has none.null も可次のいずれか"not-permitted""mailbox-login""two-factor-required"nextAvailableAtstring必須When the next export can start, or null when one can start now.
null も可形式date-timeactiveExportIdstring必須The export still being made, if there is one.
null も可countsobject必須How much an export would hold now. Null when
allowedis false.null も可threadsintegerConversations.
0以上attachmentsintegerAttachments inside them.
0以上attachmentBytesintegerThe size of those attachments, in bytes.
0以上deletedFilesintegerDeleted files, listed by name and date but not included.
0以上contactsintegerContacts.
0以上audiencesintegerAudiences.
0以上calendarEventsintegerCalendar events.
0以上templatesintegerTemplates.
0以上rulesintegerRules.
0以上labelsintegerLabels.
0以上notesintegerNotes of the caller.
0以上addressesintegerAddresses.
0以上