내보내기
이 그룹의 모든 작업: 받는 값, 반환하는 값, 응답할 수 있는 오류.
작업
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 이상