SDK

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

threads:read결과를 페이지 단위로 가져옴

시그니처

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.addressIdstring: Only imports into this address.
options.limitnumber: Rows per page, a whole number from 1 to 100. The server defaults to 25.
options.cursorstring: The nextCursor from the previous page, an import id. One that names no import this key can see is a 400 invalid_cursor.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides 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.

다른 사용처

API: GET /imports
CLI: openemail imports list

`imports.listAll()`

Collect every mailbox import into one array

threads:read결과를 페이지 단위로 가져옴

시그니처

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.addressIdstring: Only imports into this address.
options.limitnumber: Page size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstring: An import id to start after, skipping everything newer.
options.signalAbortSignal: Cancels the request in flight and rejects the whole walk.
options.apiKeystring: Overrides 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

threads:read결과를 페이지 단위로 가져옴

시그니처

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.addressIdstring: Only imports into this address.
options.limitnumber: Page size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstring: An import id to start after, skipping everything newer.
options.signalAbortSignal: Cancels the request in flight and rejects the whole walk.
options.apiKeystring: Overrides 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

threads:read

시그니처

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.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides 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)

참고

lastError is set only when status is failed.

다른 사용처

API: GET /imports/{id}
CLI: openemail imports get

`imports.create()`

Create a mailbox import and get its upload plan

threads:write

시그니처

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.keepInboxboolean: Default true: mail that was in the old inbox lands in Inbox with its unread state. False files everything under Archive.
body.options.includeSpamboolean: Default false.
body.options.includeTrashboolean: Default false.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides 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.

다른 사용처

API: POST /imports
CLI: openemail imports create

`imports.uploadState()`

See which parts of the upload have arrived

threads:write

시그니처

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.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides 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)

다른 사용처

API: GET /imports/{id}/upload
CLI: openemail imports upload-state

`imports.uploadChunk()`

Upload one part of an import file

threads:write

시그니처

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, Uint8Array or ArrayBuffer.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides 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.

다른 사용처

API: PUT /imports/{id}/files/{file}/chunks/{chunk}
CLI: openemail imports upload-chunk

`imports.start()`

Queue an import once its files are uploaded

threads:write

시그니처

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.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

반환값

ImportResource with status: queued.

예시

const queued = await openemail.imports.start(item.id) console.log(queued.status)

다른 사용처

API: POST /imports/{id}/start
CLI: openemail imports start

`imports.cancel()`

Cancel a mailbox import

threads:write

시그니처

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.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

반환값

ImportResource with status: cancelled.

예시

await openemail.imports.cancel('imp_3f9c2a7b1e4d8f60a5c7b92d')

다른 사용처

API: POST /imports/{id}/cancel
CLI: openemail imports cancel

`imports.listFailures()`

List what an import could not bring across

threads:read

시그니처

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.afternumber: The nextCursor of the previous page.
options.limitnumber: At most 100, the default.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides 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)

다른 사용처

API: GET /imports/{id}/failures
CLI: openemail imports list-failures

`imports.deleteUpload()`

Delete the files uploaded for an import

threads:write

시그니처

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.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client API key for this call only.

반환값

ImportResource with uploadDeleted: true.

예시

await openemail.imports.deleteUpload('imp_3f9c2a7b1e4d8f60a5c7b92d')

다른 사용처

API: DELETE /imports/{id}/upload
CLI: openemail imports delete-upload

`imports.importFiles()`

Create, upload and start an import in one call

threads:write

시그니처

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.optionsImportOptions: keepInbox, includeSpam and includeTrash, as for create.
input.onProgressImportProgress: Called after each part with the bytes uploaded and the total.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides 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; uploadState then tells you which parts to send before calling start.

다른 사용처

API: POST /imports
CLI: openemail imports import-files

openemail.imports

메서드

매개변수

반환값

예시

참고

다른 사용처

매개변수

반환값

예시

참고

다른 사용처

매개변수

반환값

예시

참고

다른 사용처

매개변수

반환값

예시

참고

다른 사용처

매개변수

반환값

예시

참고

다른 사용처

매개변수

반환값

예시

다른 사용처

매개변수

반환값

예시

참고

다른 사용처

매개변수

반환값

예시

다른 사용처

매개변수

반환값

예시

다른 사용처

매개변수

반환값

예시

다른 사용처

매개변수

반환값

예시

다른 사용처

매개변수

반환값

예시

참고

다른 사용처

받은편지함을,내 방식대로.

받은편지함을,
내 방식대로.