ドキュメント本文へスキップ
MCPサーバー

インポート

取り込まれる過去のメールと、別のプロバイダーからの移行。

インポートのツール

ツール機能
listImportsワークスペースへの過去のメールのインポート。新しい順で、状態と進み具合付き。addressId で 1 つのアドレスへのものに絞る。
getImportID で指定した 1 件のインポート: そのファイル、どこまで読んだか、何通のメッセージを取り込んだか。
listImportFailuresインポートが取り込めなかったメッセージとその理由。
cancelImport実行中のインポートを止める。すでに取り込んだメールは残る。アプリのチャットでは必ず先に確認する。
listProviderImportsResend など別のメールプロバイダーからのインポート。新しい順で、状態付き。
getProviderImport別のプロバイダーからの 1 件のインポートとそのレポート: 移ったもの、ここで公開するドメイン、置き換える API キー。
cancelProviderImport別のプロバイダーからの実行中のインポートを止める。すでに移したものは残る。アプリのチャットでは必ず先に確認する。

過去のメールのインポートには threads:read が、取り消すには threads:write が必要。一部のアドレスに限られたクライアントには、そのアドレスへのインポートだけが見える。

別のプロバイダーからのインポートには settings:read が、取り消すには settings:write が必要。届くのはワークスペースのオーナーだけ。

メールをアップロードしたりインポートを始めたりするツールはない。ファイルは分割してアップロードされ、別のプロバイダーからのインポートにはその API キーが要るため。アプリの「移行」ページか、REST API の POST /imports と POST /provider-imports で始める。

リファレンス

listImports

スコープthreads:readアプリのアシスタントは確認せずに実行しますツールキットworkspace

The imports of old mail into this workspace, newest first, as the Migrations page of the app lists them: the address each one fills, its status, how far it has read and how many messages it imported. addressId keeps the ones into one address. A member sees the imports into the addresses they reach. One page at a time: when more follow, the last line gives a cursor to pass back for the next page.

入力

addressIdstring
1〜128文字
limitinteger
1以上100以下
cursorstring

ほかの提供先

API
GET /imports
SDK
imports.list()imports.listAll()imports.iterate()

getImport

スコープthreads:readアプリのアシスタントは確認せずに実行しますツールキットworkspace

One import of old mail by its id: its status, the files it reads, how far it has read, and how many messages it imported, found already here, left out or could not import. listImportFailures says which messages did not import and why.

入力

idstring必須
1〜128文字

ほかの提供先

API
GET /imports/{id}
SDK
imports.get()

listImportFailures

スコープthreads:readアプリのアシスタントは確認せずに実行しますツールキットworkspace

The messages an import could not bring in, in the order it met them, with the reason for each, as What was not imported on the Migrations page shows them. When more follow, the last line gives the after value to pass back for the next page.

入力

idstring必須
1〜128文字
afterinteger
-1以上
limitinteger
1以上100以下

ほかの提供先

API
GET /imports/{id}/failures
SDK
imports.listFailures()

cancelImport

スコープthreads:writeアプリのアシスタントは必ず先に確認しますツールキットworkspace

Stop an import of old mail that is still uploading, waiting or running, as Cancel import on the Migrations page does. Mail it already imported stays in the mailbox. A chat always asks first.

入力

idstring必須
1〜128文字

ほかの提供先

API
POST /imports/{id}/cancel
SDK
imports.cancel()

listProviderImports

スコープsettings:readアプリのアシスタントは確認せずに実行しますツールキットworkspace

The imports from another email provider, such as Resend, into this workspace, newest first: what each one brings across and its status. Only the workspace owner reaches them. getProviderImport gives the full report of one. One page at a time: when more follow, the last line gives a cursor to pass back for the next page.

入力

limitinteger
1以上100以下
cursorstring

ほかの提供先

API
GET /provider-importsGET /provider-imports/{id}
SDK
providerImports.list()providerImports.listAll()providerImports.iterate()providerImports.get()

getProviderImport

スコープsettings:readアプリのアシスタントは確認せずに実行しますツールキットworkspace

One import from another email provider by its id, with its report as the Migrations page shows it: what came across, the domains to publish here, the API keys to replace and what was not brought across. Only the workspace owner reaches it.

入力

idstring必須
1〜128文字

ほかの提供先

API
GET /provider-importsGET /provider-imports/{id}
SDK
providerImports.list()providerImports.listAll()providerImports.iterate()providerImports.get()

cancelProviderImport

スコープsettings:writeアプリのアシスタントは必ず先に確認しますツールキットworkspace

Stop an import from another email provider that is still waiting or running. What it already brought across stays. Only the workspace owner can, and a chat always asks first.

入力

idstring必須
1〜128文字

ほかの提供先

API
POST /provider-imports/{id}/cancel
SDK
providerImports.cancel()