Zur Dokumentation springen
MCP-Server

Exporte

Ein Zip des ganzen Workspace.

Export-Tools

ToolWas es tut
getExportPreviewOb ein Export jetzt starten kann, wann der nächste kann, der Export, der noch erstellt wird, und wie viel ein Export enthalten würde.
listExportsDie Exporte des Workspace, die neuesten zuerst, mit Status, Fortschritt und Größe.
getExportEin Export über seine ID.
startExportEin Zip des ganzen Workspace erstellen, einmal am Tag. Es fragt nach einem Bestätigungscode, und im Chat der App fragt es immer zuerst.

Nur der Workspace-Inhaber oder ein Mitglied, dessen Rolle jede Berechtigung hat, kann exportieren, über einen Client, der mit jeder Adresse verbunden ist. Jedes Tool erfordert threads:read.

Kein Tool gibt das Zip zurück. Laden Sie es auf der Seite „Export“ der App herunter, mit GET /exports/{id}/content über die REST-API, mit exports.download im SDK oder mit openemail exports download auf der Kommandozeile.

Einige Tools auf diesem Server nehmen eine Änderung vor, die die REST API mit einem Bestätigungscode schützt, und fragen nach demselben Code. Solange der Client in den letzten 60 Minuten keinen Code bestätigt hat und die Person für ihn unter Konto → Verbundene Apps nicht Änderungen für 60 Minuten erlauben gewählt hat, antwortet ein solches Tool mit einem Ergebnis, das mit Refused (step_up_required): beginnt, und ändert nichts. emptyAudience fragt nie nach einem Code. Die Seite Authentifizierung der API nennt jedes Tool, das fragt, und zeigt, wie man einen Code anfordert und bestätigt.

Referenz

getExportPreview

Geltungsbereichethreads:readDer Assistent in der App führt es ohne Nachfrage ausToolkitworkspace

Whether this workspace can be exported now, when the next export can start, the export still being made, and how much an export would hold: conversations, attachments, contacts, audiences, calendar events, templates, rules, labels, notes and addresses.

Eingaben

Nimmt keine Eingaben an.

Auch verfügbar über

API
GET /exports/preview
SDK
exports.preview()

listExports

Geltungsbereichethreads:readDer Assistent in der App führt es ohne Nachfrage ausToolkitworkspace

The exports of this workspace, newest first, with their status, progress, size and when each is deleted. A ready one is downloaded on the Export page of the app or with GET /exports/{id}/content on the REST API.

Eingaben

limitinteger
Mindestens 1Höchstens 100
offsetinteger
Mindestens 0

Auch verfügbar über

API
GET /exportsGET /exports/{id}
SDK
exports.list()exports.get()

getExport

Geltungsbereichethreads:readDer Assistent in der App führt es ohne Nachfrage ausToolkitworkspace

One export by its id: its status, its progress through the conversations, its size and when it is deleted.

Eingaben

idstringErforderlich
1 bis 128 Zeichen

Auch verfügbar über

API
GET /exportsGET /exports/{id}
SDK
exports.list()exports.get()

startExport

Geltungsbereichethreads:readDer Assistent in der App fragt immer zuerst nachToolkitworkspace

Start making a zip of the whole workspace, as Export now on the Export page does. It is made in the background, one at a time and once a day, and kept for a year. Ask the person first.

Eingaben

Nimmt keine Eingaben an.

Auch verfügbar über

API
POST /exports
SDK
exports.start()