Get history backfill job status
GET/v1/imap/:mailerID/history/:jobId
Returns tenant-scoped status and clamped progress for a history backfill job (percent, processed/target, startedAt/endedAt). For a participants job, target is the number of emails found so far and processed the number handled, so percent can drop while the search is still finding emails (provisional is true until the job ends); totals, contacts and ignoredContacts are added and status can also be done_with_gaps. A job owned by another tenant or an unknown job returns 404. History backfill supports Google (Gmail) and Microsoft (Outlook) OAuth mailboxes and basic username/password IMAP mailboxes.
Request
Path Parameters
Mailer ID
History backfill job ID
Responses
- 200
- 400
- 404
History backfill status
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
contacts
object[]
Participants jobs only. Per-contact counts; an email naming several contacts counts for each of them.
Participants jobs only. Requested contacts dropped because they are the mailbox's own address or alias.
Participants jobs only. True while the job is still processing; counts can still change.
Participants jobs only. Why the job failed or finished with gaps.
totals
object
The same email seen again in this job (another folder or contact group); sent once.
Emails stored and queued to the webhook.
Emails already imported for this mailer (live inbound or an earlier backfill); not sent again.
Emails that could not be downloaded or parsed.
Emails deleted from the mailbox between search and download.
Emails found by the provider search so far.
Emails handled so far, whatever the outcome.
Search hits whose headers name none of the requested contacts.
{
"contacts": [
{
"contact": "a@acme.com",
"delivered": 100,
"duplicates": 15,
"found": 120,
"sentViaEdith": 5
}
],
"endedAt": "string",
"ignoredContacts": [
"owner@acme.com"
],
"jobId": "string",
"percent": 25,
"processed": 250,
"provisional": true,
"reason": "string",
"startedAt": "string",
"status": "processing",
"success": true,
"target": 1000,
"totals": {
"alreadyInJob": 3,
"delivered": 250,
"duplicates": 30,
"failed": 1,
"gone": 0,
"listed": 420,
"processed": 300,
"sentViaEdith": 15,
"unmatched": 1
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"success": false
}
Job not found
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"success": false
}