client.exports
Jede Methode in diesem Namespace: ihre Signatur, ihre Parameter, was sie zurückgibt und ein Beispiel.
Methoden
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.
exports.preview
See what an export would hold
preview(api_key: nil) -> HashReturns 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 nil.
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.
Parameter
api_keyStringOverrides the client's API key for this call only.
Rückgabe
A Hash with allowed, reason, nextAvailableAt, activeExportId and counts, a Hash of threads, attachments, attachmentBytes, deletedFiles, contacts, audiences, calendarEvents, templates, rules, labels, notes and addresses.
Beispiel
preview = client.exports.preview puts "An export can start now: #{preview[:counts]}" if preview[:allowed] && preview[:nextAvailableAt].nil?Hinweise
reasonisnot-permitted,mailbox-loginortwo-factor-required.
Auch verfügbar über
- API
GET /exports/preview- TypeScript
exports.preview()- Python
exports.preview()- CLI
openemail exports preview
exports.list
List the exports
list(limit: nil, offset: nil, api_key: nil) -> HashReturns 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.
Parameter
limitIntegerExports per page, from 1 to 100. The server defaults to 25.
offsetIntegerHow many exports to skip.
api_keyStringOverrides the client's API key for this call only.
Rückgabe
A Hash, not an OpenEmail::Page, with data, an Array of export Hashes shaped like the one get returns, plus total and hasMore. Ask for the next page with offset:.
Beispiel
exports = client.exports.list ready = exports[:data].find { |item| item[:status] == "ready" }puts ready[:id], ready[:fileName] if readyHinweise
A workspace can be exported once a day, and each export is kept for a year, so the list stays short.
Auch verfügbar über
- API
GET /exports- TypeScript
exports.list()- Python
exports.list()- CLI
openemail exports list
exports.get
Retrieve an export
get(id, api_key: nil) -> HashReturns 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.
Parameter
idStringErforderlichThe export id from
startorlist.api_keyStringOverrides the client's API key for this call only.
Rückgabe
A Hash with id, status, phase, createdAt, createdBy, startedAt, finishedAt, expiresAt, sizeBytes, fileName, threadsDone, threadsTotal and error.
Beispiel
item = client.exports.get("exp_8c1e4a7f2b9d3e6a0c5f1b28") puts item[:status], item[:threadsDone], item[:threadsTotal]Hinweise
An unknown id is a 404.
Auch verfügbar über
- API
GET /exports/{id}- TypeScript
exports.get()- Python
exports.get()- CLI
openemail exports get
exports.start
Start an export
start(api_key: nil) -> HashStarts making a zip of the whole workspace, as Export now on the Export page does, and returns 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.
Parameter
api_keyStringOverrides the client's API key for this call only.
Rückgabe
A Hash for the new export, shaped like the one get returns.
Beispiel
started = client.exports.start puts started[:id], started[:status]Hinweise
With an OAuth access token it asks for a verification code: until the app has verified one, it is refused with 403
step_up_required. An API key is never asked.An export already being made is 409
already_running, and a workspace exported in the last day is 429export_limit_reached.The SDK does not retry it.
Auch verfügbar über
- API
POST /exports- TypeScript
exports.start()- Python
exports.start()- CLI
openemail exports start
exports.download
Download an export
download(id, api_key: nil) -> StringReturns 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.
Parameter
idStringErforderlichThe export id from
startorlist.api_keyStringOverrides the client's API key for this call only.
Rückgabe
A binary String holding the zip.
Beispiel
item = client.exports.get("exp_8c1e4a7f2b9d3e6a0c5f1b28")zip = client.exports.download(item[:id]) File.binwrite(item[:fileName] || "export.zip", zip)Hinweise
With an OAuth access token it asks for a verification code: until the app has verified one, it is refused with 403
step_up_required. An API key is never asked.Before the export is
readythe call is 409export_not_ready, and an export older than a year is 409expired.The whole zip is held in memory, and a large workspace makes a large zip.
Auch verfügbar über
- API
GET /exports/{id}/content- TypeScript
exports.download()- Python
exports.download()- CLI
openemail exports download