가져오기
이 그룹의 모든 작업: 받는 값, 반환하는 값, 응답할 수 있는 오류.
작업
Two ways to bring an existing setup across.
A mailbox import reads an export file: Google Takeout archives, .mbox, .eml, .zip and .tgz. Create the import, upload each file in parts, then start it. Imported mail is quiet, so no rules, forwards, notifications, summaries or webhooks run for it.
A provider import reads a Resend account with a full-access key: suppressions, segments as audiences, subscribed contacts, templates, and webhooks created switched off, plus a checklist of the domains and API keys to recreate by hand. Inspect it first to see what would come across. The key is held encrypted only while the import runs and is erased when it ends, and running it twice duplicates nothing.
GET/imports
List mailbox imports
Every import in the workspace, newest first, one page at a time, each with its status, byte progress and running counts. Nothing is dropped from the history, so following nextCursor reaches the first import. A key limited to particular addresses sees only imports into those addresses.
Requires the threads:read scope.
쿼리 매개변수
addressIdstringOnly imports into this address.
limitintegerRows per page, 1 to 100.
1 이상100 이하기본값25cursorstringAn import id. Keyset, not offset: pass the previous page's
nextCursor. One that names nothing in this list is a 400invalid_cursor.
반환값
A page of imports, newest first, with hasMore and nextCursor.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
POST/imports
Start a mailbox import
Creates an import into one address and returns it with status: uploading. Upload each file in parts of chunkBytes with the chunk operation, then call start. The import reads Google Takeout archives, .mbox, .eml, .zip and .tgz files. Imported mail is quiet: no rules, forwards, notifications, summaries or webhooks run for it.
Requires the threads:write scope.
요청 본문
addressIdstring필수The address the mail belongs to.
filesobject[]필수Each file as
{ name, bytes }, 1 to 50 of them, each at most 100 GB.1~50개 항목namestring필수- 최대 255자
bytesinteger필수- 1 이상107374182400 이하
optionsobjectkeepInbox,includeSpamandincludeTrash, as forcreate.keepInboxbooleanDefault true. Mail that was in the old inbox lands in Inbox with its unread state; false files everything under Archive.
includeSpambooleanDefault false.
includeTrashbooleanDefault false.
반환값
The import, waiting for its files.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
GET/imports/{id}
Get a mailbox import
Status, byte progress and counts. Poll it while the import runs.
Requires the threads:read scope.
경로 매개변수
idstring필수Import id,
imp_followed by 24 hex characters.
반환값
The import.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
GET/imports/{id}/upload
Which parts have arrived
For each file, the indexes of the parts already stored, so an interrupted upload sends only what is missing.
Requires the threads:write scope.
경로 매개변수
idstring필수Import id,
imp_followed by 24 hex characters.
반환값
Received parts per file.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
DELETE/imports/{id}/upload
Delete the uploaded files
Removes the uploaded archive. Mail already imported stays in the mailbox. Refused with 409 while the import is queued or running.
Requires the threads:write scope.
경로 매개변수
idstring필수Import id,
imp_followed by 24 hex characters.
반환값
The import, with uploadDeleted: true.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
PUT/imports/{id}/files/{file}/chunks/{chunk}
Upload one part of a file
Stores bytes chunk * chunkBytes up to the next part of file file. Every part is exactly chunkBytes long except the last. Sending a part again replaces it, so a failed part can simply be retried.
Requires the threads:write scope.
경로 매개변수
idstring필수Import id,
imp_followed by 24 hex characters.fileinteger필수The file index, in the order given to
create.0 이상chunkinteger필수The part index, from 0.
0 이상
요청 본문
콘텐츠 유형application/octet-stream
반환값
The part was stored.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
POST/imports/{id}/start
Start reading the uploaded files
Checks that every part of every file has arrived and queues the import. 412 missing_chunks names the files still incomplete.
Requires the threads:write scope.
경로 매개변수
idstring필수Import id,
imp_followed by 24 hex characters.
반환값
The import, queued.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
POST/imports/{id}/cancel
Cancel a mailbox import
Stops the import at its next checkpoint. Mail already imported stays.
Requires the threads:write scope.
경로 매개변수
idstring필수Import id,
imp_followed by 24 hex characters.
반환값
The import, cancelled.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
GET/imports/{id}/failures
What an import could not bring across
Each message or archive entry that did not come across, with the reason. Page with after, the nextCursor of the previous page.
Requires the threads:read scope.
경로 매개변수
idstring필수Import id,
imp_followed by 24 hex characters.
쿼리 매개변수
afterintegerThe
nextCursorof the previous page.limitintegerAt most 100, the default.
1 이상100 이하
반환값
Failures.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
POST/provider-imports/inspect
Look inside a Resend account before importing
Reads the first page of each resource with a full-access Resend key and returns what an import would bring. Nothing is stored and the key is not kept. A sending-only key is 400 restricted_key.
Requires the settings:write scope.
요청 본문
apiKeystring필수- 8~200자
반환값
Counts per resource.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
GET/provider-imports
List imports from sending providers
Every provider import in the workspace, newest first, one page at a time, each with its report. Follow nextCursor to reach the first one.
Requires the settings:read scope.
쿼리 매개변수
limitintegerRows per page, 1 to 100.
1 이상100 이하기본값25cursorstringA provider import id. Keyset, not offset: pass the previous page's
nextCursor. One that names nothing in this list is a 400invalid_cursor.
반환값
A page of provider imports, newest first, with hasMore and nextCursor.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
POST/provider-imports
Import from Resend
Starts an import from a Resend account: suppressions, segments as audiences, subscribed contacts, templates, and webhooks created switched off, plus a checklist of domains and API keys. The key is held encrypted only while the import runs and is erased when it ends. Running it twice duplicates nothing.
Requires the settings:write scope.
요청 본문
apiKeystring필수A full-access Resend API key.
8~200자resourcesstring[]필수Any of
suppressions,audiences,contacts,templates,webhooks,domainsandapi-keys.최소 1개 항목다음 중 하나"suppressions""audiences""contacts""templates""webhooks""domains""api-keys"
반환값
The import, queued.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
GET/provider-imports/{id}
Get an import from a sending provider
Status, current step and the report so far.
Requires the settings:read scope.
경로 매개변수
idstring필수Provider import id,
pimp_followed by 24 hex characters.
반환값
The provider import.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록
다른 사용처
POST/provider-imports/{id}/cancel
Cancel an import from a sending provider
Stops it and erases the key. What already came across stays.
Requires the settings:write scope.
경로 매개변수
idstring필수Provider import id,
pimp_followed by 24 hex characters.
반환값
The provider import, cancelled.
오류
모든 작업이 반환할 수 있는 오류400401403404422500오류 목록