Skip to main content

EmailBatchProgress

batchstring
totalinteger

Messages in the batch; queued messages an administrator deleted are no longer counted

queuedinteger

Waiting to be sent, due now or waiting for a retry

sendinginteger

Being sent by a run right now

sentinteger

Accepted by the SMTP server (acceptance is not delivery)

failedinteger

Refused, or still failing after the last attempt

skippedinteger

Email was switched off when the message's turn came

dueinteger

Queued messages that may be sent now

nextAttemptstringnullable

When the earliest retry is due

Example: 2026-10-14 10:25:00
doneboolean

Nothing is queued or being sent

failures object[]

The failed messages and the server's answer

  • Array [
  • addressstring
    errorstring
  • ]
  • EmailBatchProgress
    {
    "batch": "string",
    "total": 0,
    "queued": 0,
    "sending": 0,
    "sent": 0,
    "failed": 0,
    "skipped": 0,
    "due": 0,
    "nextAttempt": "2026-10-14 10:25:00",
    "done": true,
    "failures": [
    {
    "address": "string",
    "error": "string"
    }
    ]
    }

    Can't find what you need? Ask in Discord, or open an issue on the ChurchCRM repository.