Read mail history import progress
Returns import status, counts, and bounded failure reasons. Request: GET /v1/mailboxes/{id}/imports/{importId}. Scope: mailboxes:read.
GET
Returns import status, counts, and bounded failure reasons.
apiKeyheader
x-api-key<token>id*stringMatch
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$importId*stringMailHistoryImportJob
application/json- response
id*stringmailboxId*MailboxIdMatch
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$status*stringValue in
"queued""running""done""failed"imported*integerRange
0 <= value <= 9007199254740991skippedDuplicate*integerRange
0 <= value <= 9007199254740991skippedSpamTrash*integerRange
0 <= value <= 9007199254740991failed*integerRange
0 <= value <= 9007199254740991failures*array<>import { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.mailboxes.getImport({
"id": "example",
"importId": "example"
});Example Response
{
"id": "string",
"mailboxId": "string",
"status": "queued",
"imported": 0,
"skippedDuplicate": 0,
"skippedSpamTrash": 0,
"failed": 0,
"failures": [
{
"offset": 0,
"message": "string"
}
]
}