EmailBatch

Type

One marketing blast aggregated: recipients, accepted, and per-status counts.

A blast aggregated. recipients counts every row; accepted counts only those the provider took, and is the honest denominator for a per-blast rate. When the send was queued, status tracks its delivery lifecycle and pending plus the chunk counts show how far it has drained; all four are null for a small inline send that had already finished when the call resolved, so read null as done rather than unknown.

EmailBatch.ts

interface EmailBatch {
  batchId: string
  subject: string | null
  startedAt: string
  recipients: number
  accepted: number
  counts: Record<EmailMessageStatus, number>
  status: EmailBatchLifecycle | null
  chunksTotal: number | null
  chunksDone: number | null
  pending: number | null
}

Fields

batchId

string

The blast id.

subject

string | null

The subject line, if any.

startedAt

string

When the blast began.

recipients

number

Every row, including those never handed to the provider.

accepted

number

Those the provider took; the honest rate denominator.

counts

Record<EmailMessageStatus, number>

Per-status breakdown for the blast.

status

EmailBatchLifecycle | null

Delivery lifecycle when the send was queued. Null means it was delivered inline and already finished, so treat null as done, not unknown.

chunksTotal

number | null

Delivery-chunk total when queued; null otherwise.

chunksDone

number | null

Delivery chunks completed when queued; null otherwise.

pending

number | null

Recipients not yet attempted when queued; null otherwise.