خروجی‌ها
هر عملیات در این گروه: آنچه می‌پذیرد، آنچه برمی‌گرداند و خطاهایی که ممکن است با آن‌ها پاسخ دهد.
عملیات‌ها
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.
دست‌کم 0hasMorebooleanWhether 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.
دست‌کم 0attachmentsintegerAttachments inside them.
دست‌کم 0attachmentBytesintegerThe size of those attachments, in bytes.
دست‌کم 0deletedFilesintegerDeleted files, listed by name and date but not included.
دست‌کم 0contactsintegerContacts.
دست‌کم 0audiencesintegerAudiences.
دست‌کم 0calendarEventsintegerCalendar events.
دست‌کم 0templatesintegerTemplates.
دست‌کم 0rulesintegerRules.
دست‌کم 0labelsintegerLabels.
دست‌کم 0notesintegerNotes of the caller.
دست‌کم 0addressesintegerAddresses.
دست‌کم 0