Skip to main content

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

    mailerID stringrequired

    Mailer ID

    jobId stringrequired

    History backfill job ID

Responses​

History backfill status

Schema

    contacts

    object[]

    Participants jobs only. Per-contact counts; an email naming several contacts counts for each of them.

  • Array [

  • contact string
    delivered integer
    duplicates integer
    found integer
    sentViaEdith integer
  • ]

  • endedAt string
    ignoredContacts string[]

    Participants jobs only. Requested contacts dropped because they are the mailbox's own address or alias.

    jobId string
    percent number
    processed integer
    provisional boolean

    Participants jobs only. True while the job is still processing; counts can still change.

    reason string

    Participants jobs only. Why the job failed or finished with gaps.

    startedAt string
    status string
    success boolean
    target integer

    totals

    object

    alreadyInJob integer

    The same email seen again in this job (another folder or contact group); sent once.

    delivered integer

    Emails stored and queued to the webhook.

    duplicates integer

    Emails already imported for this mailer (live inbound or an earlier backfill); not sent again.

    failed integer

    Emails that could not be downloaded or parsed.

    gone integer

    Emails deleted from the mailbox between search and download.

    listed integer

    Emails found by the provider search so far.

    processed integer

    Emails handled so far, whatever the outcome.

    sentViaEdith integer
    unmatched integer

    Search hits whose headers name none of the requested contacts.

Loading...