Email

Email

📄️ Queue a composer email, one message per recipient, for sending through the configured SMTP server

Recipients are given as person and family ids, never as addresses: the server resolves each id to its current email address, applies the do-not-email property, skips deceased people, inactive families and ids without an address, deduplicates addresses, and reports every skipped recipient by name. Each recipient receives their own message. Nothing is sent inside this request: every message is queued (email history status `queued`) under one batch id and the call returns at once. POST /email/batches/{batch}/send sends the batch now in bounded steps; whatever is left goes out with the timer jobs (cron, or the page-load fallback). `sent` and `failed` are always empty here and are kept for older clients; follow the batch for outcomes.

📄️ Progress of a queued composer send

Counts of the batch's messages by email history status. Only the user who queued the batch, or an administrator, may read it.

📄️ Send the due messages of a queued composer send now

Sends the batch's due messages for up to 15 seconds or 100 messages, then returns its progress. The composer calls it until nothing is due; messages waiting for a retry, and anything left when the composer closes, go out with the timer jobs. Concurrent calls and timer-job runs never send the same message twice. Only the user who queued the batch, or an administrator, may call it.

📄️ Render a composer message for its first recipient without sending it

Render a composer message for its first recipient without sending it

📄️ Page through the email history

Newest first. With personId or familyId the caller must be allowed to view that record. Without either it is the email log: an administrator sees everyone's mail, a user with the Email permission only the mail they queued, filtered by status, kind, sentBy and q.

📄️ One email history row with its stored body

One email history row with its stored body