Exporte
Jede Operation in dieser Gruppe: was sie annimmt, was sie zurückgibt und mit welchen Fehlern sie antworten kann.
Operationen
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.
Rückgabe
What an export would hold, and whether one can start.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
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.
Query-Parameter
limitintegerExports per page, 1 to 100.
Mindestens 1Höchstens 100Standard25offsetintegerHow many exports to skip.
Mindestens 0Standard0
Rückgabe
A page of exports, newest first.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
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.
Rückgabe
The export, queued.
Fehler
- 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.
Die Fehler, die jede Operation zurückgeben kann400401404422500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe export id from
GET /exportsorPOST /exports.
Rückgabe
The export.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
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.
Pfadparameter
idstringErforderlichThe export id from
GET /exportsorPOST /exports.
Rückgabe
application/zipThe zip.
Fehler
- 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.
Die Fehler, die jede Operation zurückgeben kann400401404422500Fehlerkatalog
Auch verfügbar über
Objekte
Exportobject
objectstringErforderlich- Einer von
"export" idstringErforderlichstatusstringErforderlich- Einer von
"queued""running""ready""failed""expired" phasestringWhat it is doing while
statusisrunning.Kann null seinEiner von"planning""mail""records""finishing"createdAtstringErforderlich- Format
date-time createdByobjectWho started it, or null when that account is gone.
Kann null seinnamestring- Kann null sein
emailstring
startedAtstring- Kann null seinFormat
date-time finishedAtstring- Kann null seinFormat
date-time expiresAtstringWhen the zip is deleted, a year after it was made.
Kann null seinFormatdate-timesizeBytesinteger- Kann null sein
fileNamestring- Kann null sein
threadsDoneinteger- Mindestens 0
threadsTotalinteger- Kann null sein
errorstringWhy it failed, when
statusisfailed.Kann null sein
ExportListobject
objectstring- Einer von
"list" dataExport[]totalintegerHow many exports there are in all.
Mindestens 0hasMorebooleanWhether more exports follow this page.
ExportPreviewobject
objectstringErforderlich- Einer von
"export_preview" allowedbooleanErforderlichWhether the caller may export this workspace.
reasonstringErforderlichWhy 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.Kann null seinEiner von"not-permitted""mailbox-login""two-factor-required"nextAvailableAtstringErforderlichWhen the next export can start, or null when one can start now.
Kann null seinFormatdate-timeactiveExportIdstringErforderlichThe export still being made, if there is one.
Kann null seincountsobjectErforderlichHow much an export would hold now. Null when
allowedis false.Kann null seinthreadsintegerConversations.
Mindestens 0attachmentsintegerAttachments inside them.
Mindestens 0attachmentBytesintegerThe size of those attachments, in bytes.
Mindestens 0deletedFilesintegerDeleted files, listed by name and date but not included.
Mindestens 0contactsintegerContacts.
Mindestens 0audiencesintegerAudiences.
Mindestens 0calendarEventsintegerCalendar events.
Mindestens 0templatesintegerTemplates.
Mindestens 0rulesintegerRules.
Mindestens 0labelsintegerLabels.
Mindestens 0notesintegerNotes of the caller.
Mindestens 0addressesintegerAddresses.
Mindestens 0