Saltar para a documentação
Servidor MCP

Importações

Correio antigo a chegar e mudanças de outro fornecedor.

Ferramentas de importações

FerramentaO que faz
listImportsAs importações de correio antigo para o espaço de trabalho, as mais recentes primeiro, com o seu estado e progresso. addressId mantém só as de um endereço.
getImportUma importação pelo seu id: os seus ficheiros, até onde leu e quantas mensagens importou.
listImportFailuresAs mensagens que uma importação não conseguiu trazer, e porquê.
cancelImportPara uma importação que ainda está a decorrer. O correio que já importou fica. No chat da app pergunta sempre primeiro.
listProviderImportsAs importações de outro fornecedor de email, como o Resend, as mais recentes primeiro, com o seu estado.
getProviderImportUma importação de outro fornecedor com o seu relatório: o que veio, os domínios a publicar aqui e as chaves de API a substituir.
cancelProviderImportPara uma importação de outro fornecedor que ainda está a decorrer. O que já trouxe fica. No chat da app pergunta sempre primeiro.

As importações de correio antigo precisam de threads:read, e de threads:write para cancelar uma. Um cliente limitado a alguns endereços só vê as importações para eles.

As importações de outro fornecedor precisam de settings:read, e de settings:write para cancelar uma. Só o proprietário do espaço de trabalho chega a elas.

Nenhuma ferramenta envia correio nem inicia uma importação, porque os ficheiros sobem por partes e uma importação de outro fornecedor precisa da sua chave de API. Inicie uma na página Migrações da app, ou com POST /imports e POST /provider-imports na API REST.

Referência

listImports

Âmbitosthreads:readO assistente da app executa-o sem perguntarConjunto de ferramentasworkspace

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.

Entradas

addressIdstring
De 1 a 128 caracteres
limitinteger
Pelo menos 1No máximo 100
cursorstring

Também disponível em

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

getImport

Âmbitosthreads:readO assistente da app executa-o sem perguntarConjunto de ferramentasworkspace

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.

Entradas

idstringObrigatório
De 1 a 128 caracteres

Também disponível em

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

listImportFailures

Âmbitosthreads:readO assistente da app executa-o sem perguntarConjunto de ferramentasworkspace

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.

Entradas

idstringObrigatório
De 1 a 128 caracteres
afterinteger
Pelo menos -1
limitinteger
Pelo menos 1No máximo 100

Também disponível em

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

cancelImport

Âmbitosthreads:writeO assistente da app pergunta sempre primeiroConjunto de ferramentasworkspace

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.

Entradas

idstringObrigatório
De 1 a 128 caracteres

Também disponível em

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

listProviderImports

Âmbitossettings:readO assistente da app executa-o sem perguntarConjunto de ferramentasworkspace

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.

Entradas

limitinteger
Pelo menos 1No máximo 100
cursorstring

Também disponível em

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

getProviderImport

Âmbitossettings:readO assistente da app executa-o sem perguntarConjunto de ferramentasworkspace

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.

Entradas

idstringObrigatório
De 1 a 128 caracteres

Também disponível em

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

cancelProviderImport

Âmbitossettings:writeO assistente da app pergunta sempre primeiroConjunto de ferramentasworkspace

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.

Entradas

idstringObrigatório
De 1 a 128 caracteres

Também disponível em

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