openemail.imports
Каждый метод этого пространства имён: его сигнатура, параметры, что он возвращает, и пример.
Методы
Bring an old mailbox across from a Google Takeout, .mbox, .eml, .zip or .tgz export, with progress and a list of what did not come through.
imports.list()
List one page of mailbox imports
list(options?: ImportListOptions): Promise<Page<ImportResource>>Returns one page of the imports in the workspace, newest first. Nothing is dropped from the history, so following nextCursor while hasMore is true reaches the very first import, and listAll and iterate do that walk for you. Each carries its status, the bytes read so far out of the total, and running counts of messages seen, imported, skipped as duplicates, left out by your options and not imported.
A key limited to particular addresses sees only imports into those addresses.
Параметры
options.addressIdstringOnly imports into this address.
options.limitnumberRows per page, a whole number from 1 to 100. The server defaults to 25.
options.cursorstringThe
nextCursorfrom the previous page, an import id. One that names no import this key can see is a 400invalid_cursor.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Возвращает
Page<ImportResource> with items, hasMore and nextCursor.
Пример
const page = await openemail.imports.list({ limit: 50 }) for (const item of page.items) { console.log(item.address, item.status, item.counts.imported)}Примечания
A GET is retried automatically on network failure and on 408, 429 and 5xx responses, up to the client
maxRetries.
Также доступно в
imports.listAll()
Collect every mailbox import into one array
listAll(options?: ImportListOptions): Promise<Array<ImportResource>>Follows nextCursor from page to page and resolves with every import in the workspace, newest first, narrowed to one address when addressId is given. A key limited to particular addresses sees only imports into those addresses.
Параметры
options.addressIdstringOnly imports into this address.
options.limitnumberPage size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstringAn import id to start after, skipping everything newer.
options.signalAbortSignalCancels the request in flight and rejects the whole walk.
options.apiKeystringOverrides the client API key for every page of this walk.
Возвращает
Array<ImportResource> holding every import across all pages.
Пример
const imports = await openemail.imports.listAll() const failed = imports.filter((item) => item.status === 'failed') console.log(`${failed.length} of ${imports.length} imports failed`)Примечания
A failure on any page rejects the whole call.
Также доступно в
- API
GET /imports
imports.iterate()
Stream mailbox imports one at a time
iterate(options?: ImportListOptions): AsyncGenerator<ImportResource, void, undefined>Returns an async generator that yields imports individually, newest first, and requests the next page only once the current one is drained. Breaking out of the loop stops the requests.
Параметры
options.addressIdstringOnly imports into this address.
options.limitnumberPage size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstringAn import id to start after, skipping everything newer.
options.signalAbortSignalCancels the request in flight and rejects the whole walk.
options.apiKeystringOverrides the client API key for every page of this walk.
Возвращает
AsyncGenerator<ImportResource, void, undefined> yielding one import per step.
Пример
for await (const item of openemail.imports.iterate({ addressId: 'addr_2b7e' })) { if (item.status === 'running') { console.log(item.id, item.counts.imported) break }}Примечания
The generator is lazy, so an abandoned loop costs only the pages you consumed.
Также доступно в
- API
GET /imports
imports.get()
Read one mailbox import
get(id: string, options?: RequestScope): Promise<ImportResource>Resolves one import with its status, byte progress and counts. Poll it while status is queued or running; it settles on completed, failed or cancelled.
An id from another workspace answers exactly like one that never existed, with 404.
Параметры
idstringОбязательноImport id,
imp_followed by 24 hex characters.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Возвращает
ImportResource.
Пример
const item = await openemail.imports.get('imp_3f9c2a7b1e4d8f60a5c7b92d') console.log(item.status, item.processedBytes, '/', item.totalBytes)Примечания
lastErroris set only whenstatusisfailed.
Также доступно в
imports.create()
Create a mailbox import and get its upload plan
create(body: ImportCreate, options?: RequestScope): Promise<ImportResource>Creates an import into one address of the workspace and returns it with status: uploading. Each file is uploaded in parts of chunkBytes, files[i].chunks of them, through uploadChunk, and start then queues the import.
The import reads Google Takeout archives, .mbox files from Apple Mail, Thunderbird and most desktop apps, .eml files, and .zip or .tgz archives holding any of those, up to 100 GB a file and 50 files an import. Threads, dates and labels come across. Imported mail is quiet: it runs no rules, forwards, notifications, summaries or webhooks.
importFiles does create, upload and start in one call.
Параметры
body.addressIdstringОбязательноThe address the mail belongs to. It must be an address this workspace owns and this key may act for.
body.filesArray<ImportFileDescriptor>ОбязательноEach file as
{ name, bytes }, 1 to 50 of them, each at most 100 GB.body.options.keepInboxbooleanDefault true: mail that was in the old inbox lands in Inbox with its unread state. False files everything under Archive.
body.options.includeSpambooleanDefault false.
body.options.includeTrashbooleanDefault false.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Возвращает
ImportResource with status: uploading, chunkBytes and each file's chunks.
Пример
const item = await openemail.imports.create({ addressId: 'addr_2b7e', files: [{ name: 'takeout-001.zip', bytes: 2147483648 }]}) console.log(item.chunkBytes, item.files[0].chunks)Примечания
An address with an import already queued or running is 409
already_running.Not retried automatically.
Также доступно в
imports.uploadState()
See which parts of the upload have arrived
uploadState(id: string, options?: RequestScope): Promise<ImportUploadResource>For each file, the indexes of the parts already stored, so an interrupted upload sends only what is missing. Empty once the import has left the uploading state.
Параметры
idstringОбязательноImport id,
imp_followed by 24 hex characters.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Возвращает
ImportUploadResource with received, one sorted array of part indexes per file.
Пример
const state = await openemail.imports.uploadState('imp_3f9c2a7b1e4d8f60a5c7b92d') console.log(state.received[0].length)Также доступно в
imports.uploadChunk()
Upload one part of an import file
uploadChunk(id: string, file: number, chunk: number, data: RawBody, options?: RequestScope): Promise<ImportChunkResource>Stores one part of file file: the bytes from chunk * chunkBytes up to the next part. Every part is exactly chunkBytes long except the last, and a part of the wrong length is 400 bad_chunk. Sending a part again replaces it, so a failed part can simply be retried.
Параметры
idstringОбязательноImport id,
imp_followed by 24 hex characters.filenumberОбязательноThe file index, in the order given to
create.chunknumberОбязательноThe part index, from 0.
dataRawBodyОбязательноThe part as a
Blob,Uint8ArrayorArrayBuffer.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Возвращает
ImportChunkResource echoing file, chunk and the bytes stored.
Пример
await openemail.imports.uploadChunk(item.id, 0, 0, bytes.subarray(0, item.chunkBytes))Примечания
Retried automatically on network failure and on 408, 429 and 5xx responses, since a repeated part replaces itself.
Также доступно в
imports.start()
Queue an import once its files are uploaded
start(id: string, options?: RequestScope): Promise<ImportResource>Checks that every part of every file has arrived, recognises each file's format and queues the import. A file still missing parts is 412 missing_chunks, and a file that is not an archive or a mailbox is 400 unsupported_file. Calling it on an import that has already left uploading returns it unchanged.
Параметры
idstringОбязательноImport id,
imp_followed by 24 hex characters.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Возвращает
ImportResource with status: queued.
Пример
const queued = await openemail.imports.start(item.id) console.log(queued.status)Также доступно в
imports.cancel()
Cancel a mailbox import
cancel(id: string, options?: RequestScope): Promise<ImportResource>Stops an import at its next checkpoint. Mail already imported stays in the mailbox. A finished import is 409 not_cancellable.
Параметры
idstringОбязательноImport id,
imp_followed by 24 hex characters.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Возвращает
ImportResource with status: cancelled.
Пример
await openemail.imports.cancel('imp_3f9c2a7b1e4d8f60a5c7b92d')Также доступно в
imports.listFailures()
List what an import could not bring across
listFailures(id: string, options?: ImportFailuresOptions): Promise<ImportFailurePage>Each message or archive entry that did not come across, with the reason: too-large (over 50 MB), unparseable, no-date, storage-error, unreadable-entry, encrypted-entry or archive-limit. Page with after, passing the nextCursor of the previous page.
Параметры
idstringОбязательноImport id,
imp_followed by 24 hex characters.options.afternumberThe
nextCursorof the previous page.options.limitnumberAt most 100, the default.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Возвращает
ImportFailurePage with data and nextCursor.
Пример
const page = await openemail.imports.listFailures(item.id) for (const failure of page.data) console.log(failure.reason, failure.subject)Также доступно в
imports.deleteUpload()
Delete the files uploaded for an import
deleteUpload(id: string, options?: RequestScope): Promise<ImportResource>Removes the uploaded archive. Mail already imported stays in the mailbox. An import still uploading is cancelled at the same time, and one that is queued or running is 409 still_running.
Параметры
idstringОбязательноImport id,
imp_followed by 24 hex characters.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Возвращает
ImportResource with uploadDeleted: true.
Пример
await openemail.imports.deleteUpload('imp_3f9c2a7b1e4d8f60a5c7b92d')Также доступно в
imports.importFiles()
Create, upload and start an import in one call
importFiles(input: ImportFilesInput, options?: RequestScope): Promise<ImportResource>Creates the import, uploads every file part by part and starts it, reporting progress through onProgress. Pass each file as a Blob, Uint8Array or ArrayBuffer; parts are sliced from it, so a Blob backed by a file on disk is never read into memory at once.
It resolves once the import is queued. Poll get to follow it.
Параметры
input.addressIdstringОбязательноThe address the mail belongs to.
input.filesArray<ImportSource>ОбязательноEach file as
{ name, data }.input.optionsImportOptionskeepInbox,includeSpamandincludeTrash, as forcreate.input.onProgressImportProgressCalled after each part with the bytes uploaded and the total.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Возвращает
ImportResource with status: queued.
Пример
import { openAsBlob } from 'node:fs' const takeout = await openAsBlob('takeout-001.zip') const item = await openemail.imports.importFiles({ addressId: 'addr_2b7e', files: [{ name: 'takeout-001.zip', data: takeout }], onProgress: (done, total) => console.log(Math.round((done / total) * 100) + '%')})Примечания
If a part fails after its retries, the import is left in
uploading;uploadStatethen tells you which parts to send before callingstart.