---
title: "openemail.emails"
description: "Every method in this namespace: its signature, its parameters, what it returns and an example."
url: "https://openemail.uk/docs/sdk/reference/emails"
area: "SDK"
category: "Reference"
---

# openemail.emails

Every method in this namespace: its signature, its parameters, what it returns and an example.

## Methods

Send mail now or later, in batches or translated, and follow what happened to it.

### `emails.send()`

Send, schedule or translate and send one email

```ts
send(body: EmailSend, options?: SendScope): Promise<SentEmailResource>
```

Sends one message now, or holds it for later with `scheduledAt` or an undo window with `cancellableForSeconds`. The body comes from exactly one source: `html` and or `text`, a stored `template`, or an existing `draftId`. Naming none is a 422, and `template` alongside `html`, `text` or `draftId` is refused. An immediate send is dispatched inside the request, so the promise usually settles on a `sent`, `partial` or `failed` message. A held send settles as `queued` or `scheduled`, so read `status` rather than treating a resolved promise as delivered mail.

Every call carries an `Idempotency-Key`. The SDK generates one per call and reuses it on that call's retries, and the API claims it against the key's own unique index before anything is dispatched, so a retried network failure replays the original message instead of sending a second one. Pass `options.idempotencyKey` to extend that across processes and restarts, deriving it from what made the send necessary rather than from a clock. A replay resolves with `replayed: true` and the stored message in its current state. The same key with a different body is a 422 `idempotency_key_reuse`.

Add `translate` to deliver the message in the recipient's language. The translation runs when the request is accepted, before any record exists, so a scheduled send carries the approved wording and a translation that cannot be produced refuses the whole send: nothing is ever delivered untranslated as a fallback. By default the subject is translated too and your original text is placed below the translation, captioned in the target language. It works with `template`, translating what the template rendered, and is refused alongside `draftId` because a draft goes as it was written.

Scopes: `emails:send`.

**Parameters**

- `body.from` (`RecipientInput`, required): Sender as `billing@acme.com`, `Acme Billing <billing@acme.com>` or `{ email, name }`. It must be an address the key may send as, otherwise 403 `from_address_forbidden`.
- `body.to` (`RecipientInput | Array<RecipientInput>`, required): One recipient or a list. `to`, `cc` and `bcc` together hold at most 50 addresses, and more is a 422 `too_many_recipients`.
- `body.cc` (`RecipientInput | Array<RecipientInput>`): Copy recipients, counted toward the 50 recipient ceiling.
- `body.bcc` (`RecipientInput | Array<RecipientInput>`): Blind copy recipients, counted toward the 50 recipient ceiling.
- `body.replyTo` (`RecipientInput`): Written into the `Reply-To` header.
- `body.subject` (`string`): At most 998 characters. Falls back to the template or draft subject when empty.
- `body.html` (`string`): HTML body, at most 1,000,000 characters.
- `body.text` (`string`): Plain text body, at most 1,000,000 characters.
- `body.template` (`{ id: string, version?: number, props?: Record<string, unknown>, slots?: Record<string, unknown> }`): A stored template by id or slug. Omitting `version` resolves whatever is published at that moment, so pin it when somebody else owns the copy.
- `body.draftId` (`string`): Sends an existing draft as written. Cannot be combined with `template` or `translate`.
- `body.threadId` (`string`): Files the sent message into an existing thread.
- `body.headers` (`Record<string, string>`): Custom headers limited to `X-*`, `List-*`, `Reply-To`, `Precedence`, `Auto-Submitted`, `Importance`, `Priority` and `Feedback-ID`. Anything the server sets itself is a 422 `reserved_header`.
- `body.attachments` (`Array<AttachmentInput>`): At most 20 files. Each entry is either an inline file, with `filename` and `content` as bytes or a base64 string (bytes are encoded for you, and inline files are capped at 5 MB in total once decoded), or a stored file as `{ fileId }` naming a file already uploaded to the workspace, which is how a file larger than the inline cap is sent.
- `body.attachmentDelivery` (`AttachmentDeliveryMode`): How the files in `attachments` travel. `mime` carries them inside the message, so a file over 5 MB is refused. `link` uploads each file and puts a download link in the body in its place, so the message itself stays small. `auto` links only when the `from` domain has an active files domain and the files together come to more than 2 MB, and attaches them otherwise, so nothing changes for a domain with no files domain set up. Left out, the sender's mailbox setting applies, and that defaults to `auto`.
- `body.scheduledAt` (`Date | string`): A `Date`, an ISO 8601 instant or a duration such as `PT1H` or `P2D`. At least one second and at most 365 days out.
- `body.cancellableForSeconds` (`number`): An undo window from 0 to 900 seconds on an immediate send. Refused alongside `scheduledAt`, which is already cancellable until it goes.
- `body.tracking` (`{ opens?: boolean, clicks?: boolean }`): Overrides the tracking setting for this send. A field left out takes the setting of the address it is sent from: its own, else its domain catch-all's when the catch-all caught that address, else off.
- `body.signature` (`boolean`): An `html` body goes out exactly as written, so it carries a signature only when this is `true`, while a `text`-only body carries one unless this is `false`. When it is added it is the signature of the address it is sent from: its own, else its domain catch-all's when the catch-all caught that address, else the OpenEmail footer unless that address turned the footer off. Template sends and encrypted sends never carry one.
- `body.tags` (`Record<string, string>`): Up to 10 tags, keys of 1 to 64 letters, digits, `_` or `-`, values up to 256 characters. Echoed back on every read.
- `body.translate` (`SendTranslateOptions`): `{ to, from?, includeOriginal?, subject? }`. `to` takes a code, an English name or an endonym. `includeOriginal` and `subject` both default to true.
- `options.idempotencyKey` (`string`): Your own key, 1 to 255 characters of letters, digits, `_`, `.`, `:` or `-`. Anything else is a 400 `invalid_idempotency_key`.
- `options.signal` (`AbortSignal`): Cancels the request. An aborted send may still have been accepted, so retry with the same `idempotencyKey`.
- `options.apiKey` (`string`): Sends with this key instead of the client's, for a process sending on behalf of several workspaces.

**Returns**

`SentEmailResource`, an `EmailResource` plus `replayed`. Notable fields are `id` (`msg_` plus 24 hex), `status`, `mode`, `from`, `subject`, `scheduledAt`, `cancellableUntil`, `sentAt`, `lastError`, `tags` and, on a translated send, `translation`.

**Example**

```ts
const sent = await openemail.emails.send({
    from: 'Acme Billing <billing@acme.com>',
    to: 'ada@example.de',
    subject: 'Your September invoice',
    html: '<p>The invoice is attached. Tell me if anything on it looks wrong.</p>',
    translate: { to: 'de' },
    tags: { invoice: 'inv_2026_09_4192' }
}, {
    idempotencyKey: 'invoice:inv_2026_09_4192'
})

console.log(sent.id, sent.status, sent.replayed, sent.translation?.language)
```

**Notes**

- A `from` on a domain that is known to the workspace but cannot sign mail yet is refused up front with 409 `domain_not_sendable` and `param` set to `from`, so nothing is accepted that would only fail at dispatch. `addresses.list` shows the same verdict as `canSend` before you send.
- A test key (`oe_test_`) never delivers. The message is marked `sent` with `transport` set to `test` and every recipient `delivered`, so assert on the response and not on an inbox.
- The idempotency fingerprint covers the template version the send resolved to. Retrying an unpinned template send after somebody publishes a new version is a 422 `idempotency_key_reuse`, not a replay. `scheduledAt` is left out of the fingerprint.
- A spent send allowance is a 429 `send_quota_exceeded` with no `Retry-After`, and it resets on the first of the month. The SDK does not retry a 429 that carries no `Retry-After`, so it throws straight away.
- Translation failures refuse the send: 409 `translation_not_configured` when the workspace has no AI, 422 `translation_too_long` past 30,000 characters, 429 `ai_quota_exceeded` when the workspace has used today's AI actions, and 503 `translation_failed` when the provider did not answer.
- A translated send spends one AI action. `isRetryable` is true for every 429, but `ai_quota_exceeded` fails the same way until the allowance resets at midnight UTC, so show it to a person or send without `translate`.

Also available in: API [`POST /emails`](https://openemail.uk/docs/api/reference/emails#post-emails); CLI [`openemail emails send`](https://openemail.uk/docs/cli/reference/emails#emails-send).

### `emails.sendBatch()`

Send up to 100 independent emails in one request

```ts
sendBatch(emails: Array<EmailSend>, options?: SendScope): Promise<BatchResultResource>
```

Sends each message in order, as if `emails.send` had been called for it, and reports per item. It is never all or nothing: a bad address on item 7 fails item 7 and the rest still go, because a batch that rolled back would turn your retry into a guess about which messages had already been delivered. The promise resolves whenever the batch was processed, so check `failed` and each item's `status` rather than relying on a throw.

The batch shares one `Idempotency-Key`, generated once per call or supplied as `options.idempotencyKey`, and the server derives a separate key per item from it and the item's position. Retrying the same array replays the items that already went and sends only the ones that did not. Reordering the array between attempts changes which body each position's key is bound to, so an item that moved comes back as an `idempotency_key_reuse` error.

Apart from a key or scope failure or a server fault, only problems with the batch as a whole reject the promise with a 422: an empty array, more than 100 messages, or more than 10 messages carrying `translate`. Translation costs several model calls per message and they run one after another, so a larger translated batch would time out partway. Split it, or schedule the messages instead.

Scopes: `emails:send`.

**Parameters**

- `emails` (`Array<EmailSend>`, required): Between 1 and 100 messages, each shaped exactly like the body of `emails.send` and validated on its own.
- `options.idempotencyKey` (`string`): Your own batch key, 1 to 255 characters of letters, digits, `_`, `.`, `:` or `-`.
- `options.signal` (`AbortSignal`): Cancels the request. Items processed before the abort may already have been sent.
- `options.apiKey` (`string`): Sends the batch with this key instead of the client's.

**Returns**

`BatchResultResource` with `sent`, `failed` and `items`. Each item has its `index` and either `status: 'ok'` with the `email` (a `SentEmailResource`) or `status: 'error'` with an `error` carrying `type`, `code`, `message` and, when a field is to blame, `param`.

**Example**

```ts
const result = await openemail.emails.sendBatch([
    { from: 'dispatch@acme.com', to: 'ada@example.com', subject: 'Order AC-4192 has shipped', text: 'It is on its way.' },
    { from: 'dispatch@acme.com', to: 'grace@example.com', subject: 'Order AC-4193 has shipped', text: 'It is on its way.' }
], {
    idempotencyKey: 'shipments:2026-09-15'
})

for (const item of result.items) {
    if (item.status === 'error') console.error(item.index, item.error.code, item.error.message)
}

console.log(result.sent, result.failed)
```

**Notes**

- Each entry is authorised on its own, so a `from` on a domain that cannot sign yet fails that entry with `domain_not_sendable` while the rest go.
- Once the send allowance of the workspace runs out partway, every remaining item fails with `send_quota_exceeded` while the earlier ones stay sent. It is counted for that workspace alone, so sends from other workspaces never spend it. A workspace on a paid plan with pay as you go turned on keeps sending past it instead.
- Each item with `translate` spends one AI action. Once that account has used today's AI actions, every remaining item with `translate` fails with `ai_quota_exceeded` while items without it still go. Retrying those items fails the same way until the allowance resets at midnight UTC, unless the account has pay as you go turned on.
- An unexpected server fault aborts the batch with a 500 after the earlier items have gone. The SDK retries it with the same key, which replays those items instead of sending them twice.
- Items are processed one after another inside a single request, so a large batch of immediate sends takes noticeably longer than one `send`. Keep the client `timeoutMs` generous.

Also available in: API [`POST /emails/batch`](https://openemail.uk/docs/api/reference/emails#post-emails-batch); CLI [`openemail emails send-batch`](https://openemail.uk/docs/cli/reference/emails#emails-send-batch).

### `emails.translate()`

Preview a translation without sending anything

```ts
translate(body: EmailTranslate, options?: RequestScope): Promise<TranslationResource>
```

Runs the same translation `translate` performs on a send and stops one step early. The same function produces both, so what comes back is what would go out. Nothing is stored and nothing is sent. Use it when somebody should read the translated wording before it reaches a recipient.

Send the approved result as an ordinary `subject` and `html` on `emails.send` with no `translate` option. Passing `translate` again translates a second time, moving the wording off the version that was signed off and discarding any edits. When `includeOriginal` is on, `html` already contains your original text below the translation, so do not append your own copy.

At least one of `html`, `text` or `subject` is required. `to` accepts a BCP-47 code, an English name or the language's own name, and the response reports the code it settled on in `language.code`, which is the form worth storing. State `from` to skip language detection. Otherwise it is detected from the body, and a detector that cannot tell returns null in `detectedSourceLanguage` rather than guessing.

Scopes: `emails:send`.

**Parameters**

- `body.to` (`string`, required): Target language as a code (`de`), English name (`German`) or endonym (`Deutsch`). An unrecognised value is a 422 `invalid_parameter` on `to`.
- `body.from` (`string`): The language you wrote in. Stating it skips the detection call.
- `body.includeOriginal` (`boolean`): Defaults to true, placing your original text below the translation under a caption in the target language.
- `body.subject` (`string`): Subject line to translate, at most 998 characters.
- `body.html` (`string`): HTML body to translate. Only the content inside `<body>` is sent to the model when the markup is a full document.
- `body.text` (`string`): Plain text body to translate. Translated separately when given alongside `html`.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Runs the preview with this key instead of the client's.

**Returns**

`TranslationResource` with `object` set to `translation`, `language` and `detectedSourceLanguage` as full `LanguageResource` rows, `subject`, `html` and `text` (each null when that input was not given) and `includeOriginal`.

**Example**

```ts
const preview = await openemail.emails.translate({
    to: 'ja',
    subject: 'Your September invoice',
    html: '<p>The invoice is attached.</p>'
})

console.log(preview.language.native, preview.detectedSourceLanguage?.code)

await openemail.emails.send({
    from: 'Acme Billing <billing@acme.com>',
    to: 'ada@example.jp',
    subject: preview.subject ?? 'Your September invoice',
    html: preview.html ?? '<p>The invoice is attached.</p>'
})
```

**Notes**

- The SDK never retries this call. Each attempt spends one AI action, as a translated send does. Handle a 503 `translation_failed` yourself, and treat a 429 `ai_quota_exceeded` as final until the allowance resets at midnight UTC.
- Anything over 30,000 characters is refused with 422 `translation_too_long` rather than truncated, since half a translation has no seam to show where it stopped.
- A right-to-left target comes back with `html` wrapped in `dir="rtl"`.
- A workspace with no AI configured gets 409 `translation_not_configured`, and retrying will fail the same way.

Also available in: API [`POST /emails/translate`](https://openemail.uk/docs/api/reference/emails#post-emails-translate); CLI [`openemail emails translate`](https://openemail.uk/docs/cli/reference/emails#emails-translate).

### `emails.check()`

Check how a message would be rated, without sending it

```ts
check(body: EmailCheck, options?: RequestScope): Promise<EmailCheckResource>
```

Scores a message the way a receiving mailbox would, before it goes out: a spam score, a phishing score and an AI-writing score, each 0 to 100, with the signals behind each one. Nothing is stored and nothing is sent.

The same checks score every message that arrives in an OpenEmail mailbox, so what comes back is what an OpenEmail recipient sees in Details. It cannot know a recipient's own filter, sender history or reputation, so a low score is a good sign and not a delivery guarantee.

Run it before an automated send, or as someone writes, and fix what `signals` names. Sender authentication is taken as passing, since the message will be signed for your domain.

Scopes: `emails:send`.

**Parameters**

- `body.subject` (`string`): Subject line, at most 998 characters.
- `body.html` (`string`): HTML body. Links and images are read from it.
- `body.text` (`string`): Plain text body. Taken from `html` when left out.
- `body.from` (`string`): The address it will be sent from.
- `body.fromName` (`string`): The display name it will carry. A name that claims another address or a known brand raises the phishing score.
- `body.replyTo` (`string`): A Reply-To on a different domain raises the phishing score.
- `body.replying` (`boolean`): True when it answers an existing thread. A `Re:` subject on a message that answers nothing raises the spam score.
- `body.attachmentNames` (`Array<string>`): File names, so an attachment that can run code is caught.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Runs the check with this key instead of the client's.

**Returns**

`EmailCheckResource` with `object` set to `email_check` and three scores. `spam` carries `score`, `level` (`low`, `medium` from 35, `high` from 60) and `signals`. `phishing` carries `score`, `level` (`clear`, `caution` from 30, `danger` from 60), `signals` and `reasons`. `ai` carries `score` (null when not judged), `level`, `signals`, `reasons`, `words` and `skipped` (`too-short` under 40 words).

**Example**

```ts
const check = await openemail.emails.check({
    from: 'billing@acme.com',
    subject: 'Your September invoice',
    html: '<p>The invoice is attached.</p>'
})

if (check.spam.level !== 'low') console.log('Rework it first:', check.spam.signals)

console.log(check.spam.score, check.phishing.score, check.ai.score)
```

**Notes**

- It spends no AI action and never calls a model, so it is safe to run on every revision.
- A score is not a probability. Each one adds up weighted signals, heaviest first in `signals`.

Also available in: API [`POST /emails/check`](https://openemail.uk/docs/api/reference/emails#post-emails-check); CLI [`openemail emails check`](https://openemail.uk/docs/cli/reference/emails#emails-check).

### `emails.list()`

List one page of sent emails, newest first

```ts
list(options?: EmailListOptions): Promise<Page<EmailResource>>
```

Returns one page of the workspace's send records, ordered newest first. Paging is keyset rather than offset: `nextCursor` is the id of the last message on the page, and passing it back as `cursor` continues strictly after it, so messages sent while you page never shift or repeat rows. `hasMore` is false on the last page and `nextCursor` is then null.

Filter with `status`, one value or an array that the SDK joins with commas, with `from`, which matches the sending address exactly and ignores case, with `broadcastId`, which keeps the copies of one broadcast, and with `scheduledFrom` and `scheduledTo`, which keep the messages scheduled inside a window. An unrecognised status is a 422 `invalid_parameter` naming the offending values, and a cursor that names no message in the workspace is a 400 `invalid_cursor`.

Rows are the summary form. They never carry `recipients` or `translation`, whose absence on a row says nothing either way, and a tracked message carries only the counts half of `tracking`: `opens`, `clicks`, `opened`, `clicked`, `openCount`, `clickCount` and `firstOpenAt`. Call `get` for per-recipient delivery state and `getTracking` for the full engagement report.

Scopes: `emails:read`.

**Parameters**

- `options.status` (`EmailStatus | Array<EmailStatus>`): One or more of `queued`, `scheduled`, `sending`, `sent`, `partial`, `cancelled` and `failed`.
- `options.from` (`string`): A bare sending address such as `billing@acme.com`, matched exactly and case insensitively. A display name form does not match.
- `options.broadcastId` (`string`): Only the copies of one broadcast, a `brd_` id from `broadcasts.send`. Each person a broadcast reaches gets a message of their own, so this lists who it went to and what happened to each copy. An id that names no broadcast answers an empty page.
- `options.scheduledFrom` (`Date | string`): Only messages scheduled for this instant or later. With `scheduledTo` and `status: ['scheduled', 'queued']` it lists what is waiting to go out in a window, as the calendar of the app does. A message with no `scheduledAt` is left out.
- `options.scheduledTo` (`Date | string`): Only messages scheduled for this instant or earlier. `scheduledFrom` after `scheduledTo` is a 422 `invalid_parameter`.
- `options.limit` (`number`): Rows per page, a whole number from 1 to 100, defaulting to 25. Outside that range is a 422.
- `options.cursor` (`string`): The `nextCursor` from the previous page, which is a message id.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Lists with this key instead of the client's.

**Returns**

`Page<EmailResource>` with `items`, `hasMore` and `nextCursor`. Each item has `id`, `status`, `mode`, `from`, `subject`, `transport`, `attempts`, `lastError`, `scheduledAt`, `cancellableUntil`, `sentAt`, `tags`, `broadcastId`, `source`, `createdAt` and, when tracked, the trimmed `tracking` counts.

**Example**

```ts
const page = await openemail.emails.list({
    status: ['failed', 'partial'],
    from: 'billing@acme.com',
    limit: 50
})

for (const email of page.items) console.log(email.id, email.status, email.lastError)

if (page.hasMore) {
    const next = await openemail.emails.list({ status: ['failed', 'partial'], cursor: page.nextCursor ?? undefined })

    console.log(next.items.length)
}
```

**Notes**

- With a narrowed key only messages sent from addresses it covers are read, and the page is cut after that filter, so every page but the last holds `limit` items. A key that holds a whole domain covers every address on it.
- A `from` the key does not cover returns an empty last page rather than a 403.
- `tracking` is absent, not zeroed, on a message that carried no pixel or rewritten link.

Also available in: API [`GET /emails`](https://openemail.uk/docs/api/reference/emails#get-emails); CLI [`openemail emails list`](https://openemail.uk/docs/cli/reference/emails#emails-list).

### `emails.listAll()`

Collect every matching sent email into one array

```ts
listAll(options?: EmailListOptions): Promise<Array<EmailResource>>
```

Follows `nextCursor` from page to page and resolves once the last page has been read, with every matching send record in one array, newest first. It accepts the same filters as `list` and returns the same summary rows, so there are no `recipients` or `translation` on them and `tracking` is the trimmed counts form.

Everything is held in memory before the promise settles, and a workspace's send history grows without bound. Narrow it with `status` or `from`, or switch to `iterate` when you want to stop early or process rows as they arrive. `limit` sets the page size of each underlying request, not the total, so a larger value means fewer round trips.

Scopes: `emails:read`.

**Parameters**

- `options.status` (`EmailStatus | Array<EmailStatus>`): One or more statuses to keep, joined with commas on the wire.
- `options.from` (`string`): A bare sending address, matched exactly and case insensitively.
- `options.broadcastId` (`string`): Only the copies of one broadcast, a `brd_` id.
- `options.scheduledFrom` (`Date | string`): Only messages scheduled for this instant or later.
- `options.scheduledTo` (`Date | string`): Only messages scheduled for this instant or earlier.
- `options.limit` (`number`): Page size per request, from 1 to 100, defaulting to 25 on the server.
- `options.cursor` (`string`): A message id to start after, skipping everything newer.
- `options.signal` (`AbortSignal`): Cancels the request in flight and rejects the whole collection.
- `options.apiKey` (`string`): Lists with this key instead of the client's.

**Returns**

`Array<EmailResource>` holding every row across all pages.

**Example**

```ts
const scheduled = await openemail.emails.listAll({ status: 'scheduled', limit: 100 })

const dueToday = scheduled.filter((email) => email.scheduledAt?.startsWith('2026-09-15'))

console.log(scheduled.length, dueToday.map((email) => email.id))
```

**Notes**

- A failure on any page rejects the whole call, and the rows already fetched are discarded.
- With a narrowed key only messages sent from addresses it covers are collected, and every page but the last is full.

Also available in: API [`GET /emails`](https://openemail.uk/docs/api/reference/emails#get-emails).

### `emails.iterate()`

Stream sent emails one at a time across pages

```ts
iterate(options?: EmailListOptions): AsyncGenerator<EmailResource, void, undefined>
```

Returns an async generator that yields send records individually, newest first, and requests the next page only once the current one is drained. Nothing is fetched until you start consuming it, and breaking out of the loop stops the requests, so this is the cheapest way to find the most recent message matching a condition the filters cannot express.

The walk is keyset based, following `nextCursor` from page to page. Mail sent while you iterate lands ahead of where you started and is never yielded, and nothing already yielded comes round again. Rows are the same summary form `list` returns.

Scopes: `emails:read`.

**Parameters**

- `options.status` (`EmailStatus | Array<EmailStatus>`): One or more statuses to keep, joined with commas on the wire.
- `options.from` (`string`): A bare sending address, matched exactly and case insensitively.
- `options.broadcastId` (`string`): Only the copies of one broadcast, a `brd_` id.
- `options.scheduledFrom` (`Date | string`): Only messages scheduled for this instant or later.
- `options.scheduledTo` (`Date | string`): Only messages scheduled for this instant or earlier.
- `options.limit` (`number`): Page size per request, from 1 to 100, defaulting to 25 on the server.
- `options.cursor` (`string`): A message id to start after.
- `options.signal` (`AbortSignal`): Cancels the request in flight and ends the iteration with an error.
- `options.apiKey` (`string`): Lists with this key instead of the client's.

**Returns**

`AsyncGenerator<EmailResource, void, undefined>` yielding one send record per step.

**Example**

```ts
for await (const email of openemail.emails.iterate({ status: 'failed', limit: 100 })) {
    if (email.tags.invoice === 'inv_2026_09_4192') {
        console.log(email.id, email.lastError)
        break
    }
}
```

**Notes**

- The generator is lazy, so an abandoned loop costs only the pages you consumed.
- With a narrowed key only messages sent from addresses it covers are yielded, and every page but the last is full.

Also available in: API [`GET /emails`](https://openemail.uk/docs/api/reference/emails#get-emails).

### `emails.get()`

Read one sent email with per-recipient state

```ts
get(id: string, options?: RequestScope): Promise<EmailResource>
```

Returns the full send record for one message: its lifecycle `status`, delivery `attempts` and `lastError`, the schedule fields, and the two parts a list row leaves out. `recipients` has one entry per address with its own `status`, `error` and `deliveredAt`, and `translation` records what was done to a translated send.

A message that went out as a single call can still land differently per recipient. `status` on the message says how the send went as a whole, while each recipient moves on as delivery reports, bounces and complaints arrive. `uncertain` is a real recipient state: a transport that failed partway cannot say which recipients it reached. `suppressed` marks an address that previously bounced or complained in this workspace and was held back.

When the message was tracked, `tracking` carries the full engagement report with per-recipient and per-link detail. When it was not tracked, the field is absent rather than zeroed, because a message with no pixel has no evidence about whether anybody read it.

Scopes: `emails:read`.

**Parameters**

- `id` (`string`, required): The send id, `msg_` followed by 24 hex characters, as returned by `send`.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Reads with this key instead of the client's.

**Returns**

`EmailResource` with `id`, `status`, `mode`, `from`, `subject`, `threadId`, `transport`, `attempts`, `lastError`, `scheduledAt`, `cancellableUntil`, `sentAt`, `tags`, `broadcastId`, `source`, `createdAt`, `recipients` and, when present, `translation` and the full `tracking` report.

**Example**

```ts
const email = await openemail.emails.get('msg_3f9a1c07d2b84e6a9c5b1f20')

const undelivered = email.recipients?.filter((recipient) => recipient.status !== 'delivered') ?? []

console.log(email.status, undelivered.map((recipient) => [recipient.email, recipient.status, recipient.error]))
```

**Notes**

- Do not correlate on `messageId`. The header is rewritten on the way out, so that value appears in no bounce or delivery report. Webhook events name the send by this `id`, as `emailId`.
- A 404 never distinguishes a missing id from one in another workspace, and a narrowed key gets the same 404 for a message sent from an address it does not cover.
- `transport` stays null until dispatch, and reads `test` on every message sent with a test key.

Also available in: API [`GET /emails/{id}`](https://openemail.uk/docs/api/reference/emails#get-emails-id); CLI [`openemail emails get`](https://openemail.uk/docs/cli/reference/emails#emails-get).

### `emails.listEvents()`

Read one page of the event trail of one sent email

```ts
listEvents(id: string, options?: ListOptions): Promise<Page<EmailEventResource>>
```

Returns one page of everything recorded against one send, oldest first. Nothing is dropped from the trail, so following `nextCursor` while `hasMore` is true reaches its newest event, and `listAllEvents` and `iterateEvents` do that walk for you. It is the audit behind the current `status`: when the message was accepted or held, when it was rescheduled or cancelled, when it went out or failed, and every delivery report, bounce, complaint, open, click and file download attributed to it afterwards.

Each event has a dotted `type` and a `data` object whose shape depends on it. `email.accepted`, `email.queued` and `email.scheduled` open the trail with the source and recipient count. `email.sent` names the `transport` and `messageId`. `email.failed` carries the `error`. `email.bounced` and `email.complained` list the affected `recipients` and whether they were suppressed. `email.delivered`, `email.rescheduled`, `email.cancelled`, `email.opened`, `email.clicked` and `email.downloaded` follow as they happen. `email.downloaded` counts a person fetching a file that went out as a download link, never a scanner, and carries no `recipient`: the link is the same for everyone the message went to, so a download cannot be attributed. `data` is an empty object when an event carries nothing.

Webhooks deliver a subset of these same events as they occur, so this is where to look when a webhook was missed or never subscribed.

Scopes: `emails:read`.

**Parameters**

- `id` (`string`, required): The `msg_` send id whose trail to read.
- `options.limit` (`number`): Events per page, a whole number from 1 to 100, defaulting to 25.
- `options.cursor` (`string`): The `nextCursor` from the previous page, which is an event id. One that names no event of this send is a 400 `invalid_cursor`.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Reads with this key instead of the client's.

**Returns**

`Page<EmailEventResource>` with `items`, `hasMore` and `nextCursor`. Each item has `object` set to `event`, `id`, `type`, `data` and `createdAt`.

**Example**

```ts
const page = await openemail.emails.listEvents('msg_3f9a1c07d2b84e6a9c5b1f20', { limit: 100 })

const bounce = page.items.find((event) => event.type === 'email.bounced')

console.log(page.items.map((event) => event.type), bounce?.data, page.hasMore)
```

**Notes**

- `email.delivered` is recorded in this trail but is never sent as a webhook, so a delivery report surfaces only here and in `recipients` on `get`.
- A send made with a test key records `email.sent` with `transport: 'test'` and `simulated: true` in `data`.
- An unknown id is a 404, never an empty page.
- A tracked message opened or clicked many times records one event per counted hit, so its trail can run to many pages.

Also available in: API [`GET /emails/{id}/events`](https://openemail.uk/docs/api/reference/emails#get-emails-id-events); CLI [`openemail emails list-events`](https://openemail.uk/docs/cli/reference/emails#emails-list-events).

### `emails.listAllEvents()`

Collect the whole event trail of one sent email into one array

```ts
listAllEvents(id: string, options?: ListOptions): Promise<Array<EmailEventResource>>
```

Walks every page of one send's event trail and resolves with all of it, oldest first: acceptance, scheduling, sending, every delivery report, bounce and complaint, and every counted open, click and download afterwards.

A widely read message can hold a great many events, all in memory before the promise settles. Prefer `iterateEvents` when you can stop early. `limit` sets the page size of each request, not the total.

Scopes: `emails:read`.

**Parameters**

- `id` (`string`, required): The `msg_` send id whose trail to read.
- `options.limit` (`number`): Page size per request, from 1 to 100, defaulting to 25 on the server.
- `options.cursor` (`string`): An event id to start after, skipping every older event.
- `options.signal` (`AbortSignal`): Cancels the request in flight and rejects the whole walk.
- `options.apiKey` (`string`): Reads with this key instead of the client's.

**Returns**

`Array<EmailEventResource>` holding every event across all pages, oldest first.

**Example**

```ts
const events = await openemail.emails.listAllEvents('msg_3f9a1c07d2b84e6a9c5b1f20', { limit: 100 })

const opens = events.filter((event) => event.type === 'email.opened').length

console.log(events.length, opens)
```

**Notes**

- A failure on any page rejects the whole call, and the events already fetched are discarded.
- An unknown id is a 404 on the first page.

Also available in: API [`GET /emails/{id}/events`](https://openemail.uk/docs/api/reference/emails#get-emails-id-events).

### `emails.iterateEvents()`

Stream the event trail of one sent email one event at a time

```ts
iterateEvents(id: string, options?: ListOptions): AsyncGenerator<EmailEventResource, void, undefined>
```

Returns an async generator over one send's event trail that yields events individually, oldest first, and fetches the next page only when the current one is drained. Nothing is requested until you consume it, and breaking out of the loop stops further requests.

The walk moves forward in time, so events recorded while you iterate are yielded when the walk reaches them, and it ends when `hasMore` is false.

Scopes: `emails:read`.

**Parameters**

- `id` (`string`, required): The `msg_` send id whose trail to read.
- `options.limit` (`number`): Page size per request, from 1 to 100, defaulting to 25 on the server.
- `options.cursor` (`string`): An event id to start after, skipping every older event.
- `options.signal` (`AbortSignal`): Cancels the request in flight and rejects the whole walk.
- `options.apiKey` (`string`): Reads with this key instead of the client's.

**Returns**

`AsyncGenerator<EmailEventResource, void, undefined>` yielding one event per step.

**Example**

```ts
for await (const event of openemail.emails.iterateEvents('msg_3f9a1c07d2b84e6a9c5b1f20')) {
    if (event.type === 'email.delivered') {
        console.log('delivered at', event.createdAt)
        break
    }
}
```

**Notes**

- The generator is lazy, so an abandoned loop costs only the pages you consumed.

Also available in: API [`GET /emails/{id}/events`](https://openemail.uk/docs/api/reference/emails#get-emails-id-events).

### `emails.getTracking()`

Read the engagement report for a sent email

```ts
getTracking(id: string, options?: RequestScope): Promise<TrackingResource>
```

Returns the same document `tracking.get` serves, reached from the `msg_` id a sender already holds. It has the message totals, one entry per tracked copy under `recipients`, and every rewritten link with its clicks under `links`.

A message that was never tracked is a 404 here rather than an empty report. "We were not recording" and "nobody opened it" are different answers, and a client that renders them the same way makes a claim about a reader on no evidence. Tracking applies per send: `opens` and `clicks` record what was applied when the message went out, resolved from the setting of the address it was sent from (its own, else its domain catch-all's when the catch-all caught that address, else on) and any `tracking` override on the send, not what is switched on now.

Read every count as a floor. An open is inferred from a mail client fetching an image, so a reader whose client blocks images is never counted, and Gmail fetches the image once through its proxy and serves later views from cache. A click is stronger evidence than an open.

Scopes: `emails:read`.

**Parameters**

- `id` (`string`, required): The `msg_` send id returned by `send`.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Reads with this key instead of the client's.

**Returns**

`TrackingResource` with `object` set to `tracking`, `id` (the `tmsg_` tracking id), `sendId`, `opens`, `clicks`, `opened`, `clicked`, `attributable`, `openCount`, `clickCount`, `openCountRaw`, `clickCountRaw`, the first and last open and click times, `recipients` and `links`.

**Example**

```ts
const report = await openemail.emails.getTracking('msg_3f9a1c07d2b84e6a9c5b1f20')

if (report.attributable) {
    const unopened = report.recipients.filter((recipient) => recipient.attributed && recipient.openCount === 0)

    console.log(unopened.map((recipient) => recipient.email))
}

console.log(report.openCount, report.links.map((link) => [link.url, link.clickCount]))
```

**Notes**

- Only claim a named recipient has not opened when `attributable` is true. Mail that went to the whole list as one body has a shared copy whose `email` is null, and its opens cannot be pinned to anybody.
- A message sent with a test key is never tracked, so this is always a 404 for one.
- `openCountRaw - openCount` includes machine fetches such as Apple Mail Privacy Protection and repeats within thirty seconds, so do not read the difference as a pure machine count.

Also available in: API [`GET /emails/{id}/tracking`](https://openemail.uk/docs/api/reference/tracking#get-emails-id-tracking); CLI [`openemail emails get-tracking`](https://openemail.uk/docs/cli/reference/emails#emails-get-tracking).

### `emails.cancel()`

Stop a queued or scheduled email before it goes

```ts
cancel(id: string, options?: RequestScope): Promise<EmailResource>
```

Cancels a message that has not been dispatched yet: a send held by `scheduledAt`, or an immediate send still inside its `cancellableForSeconds` undo window. The message moves to `cancelled`, nothing is delivered, and an `email.cancelled` event is recorded and sent to subscribed webhooks.

Only `queued` and `scheduled` messages can be cancelled. Once a message is `sending`, `sent`, `partial` or `failed` the call is a 409 `email_not_cancellable`, since there is no pending dispatch left to stop and mail that has gone cannot be recalled. An immediate send with no undo window is dispatched inside the `send` request, so by the time you hold its id it is usually past this point.

Cancelling is idempotent. Cancelling an already cancelled message resolves with the same cancelled message rather than an error, and the SDK retries the call after a network failure or a retryable status.

Scopes: `emails:send`.

**Parameters**

- `id` (`string`, required): The `msg_` send id to cancel.
- `options.signal` (`AbortSignal`): Cancels the HTTP request, not the email. Check `status` with `get` if you abort.
- `options.apiKey` (`string`): Cancels with this key instead of the client's.

**Returns**

`EmailResource` in its new state, with `status` set to `cancelled` and `scheduledAt` and `cancellableUntil` still showing when it would have gone.

**Example**

```ts
const queued = await openemail.emails.send({
    from: 'billing@acme.com',
    to: 'ada@example.com',
    subject: 'Your September invoice',
    text: 'Invoice attached.',
    cancellableForSeconds: 30
})

const cancelled = await openemail.emails.cancel(queued.id)

console.log(cancelled.status)
```

**Notes**

- `cancellableUntil` on the message is the moment it stops being cancellable. Past it, expect the 409.
- A cancelled message stays cancelled. There is no way to resume it, so send again if you change your mind.
- A narrowed key gets a 404 for a message sent from an address it does not cover.

Also available in: API [`POST /emails/{id}/cancel`](https://openemail.uk/docs/api/reference/emails#post-emails-id-cancel); CLI [`openemail emails cancel`](https://openemail.uk/docs/cli/reference/emails#emails-cancel).

### `emails.reschedule()`

Move a queued or scheduled email to a new send time

```ts
reschedule(id: string, scheduledAt: Date | string, options?: RequestScope): Promise<EmailResource>
```

Changes when a message that has not gone yet will be dispatched. `scheduledAt` is the only thing this call can change, and the SDK sends nothing else: the body, recipients and any translation stay exactly as they were accepted.

The new time takes a `Date`, an ISO 8601 instant or a duration such as `PT30M` or `P2D`, measured from when the server receives the request. It must be at least one second in the future and at most 365 days out, otherwise the call is a 422 on `scheduledAt`, usually `invalid_parameter`. Earlier and later times are both allowed.

Only `queued` and `scheduled` messages can be moved. Anything already `sending`, `sent`, `partial`, `cancelled` or `failed` is a 409 `email_not_cancellable`. A queued message inside its undo window can be rescheduled too, which turns it into a `scheduled` send that stays cancellable until the new time.

Scopes: `emails:send`.

**Parameters**

- `id` (`string`, required): The `msg_` send id to move.
- `scheduledAt` (`Date | string`, required): The new send time. A `Date` is serialised with `toISOString()`, and a string is passed through as an instant or a duration.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Reschedules with this key instead of the client's.

**Returns**

`EmailResource` with `status` set to `scheduled` and `scheduledAt` and `cancellableUntil` both set to the new time.

**Example**

```ts
const tomorrowMorning = new Date('2026-09-16T08:00:00Z')

const moved = await openemail.emails.reschedule('msg_3f9a1c07d2b84e6a9c5b1f20', tomorrowMorning)

console.log(moved.status, moved.scheduledAt)
```

**Notes**

- The SDK retries this call after a network failure. A duration is resolved again on each attempt, so a retried `PT1H` lands an hour after the last attempt the server received.
- An `email.rescheduled` event with the new `scheduledAt` is added to the trail on every successful move.
- A translated scheduled message keeps its approved wording. To change the text itself, cancel it and send again.

Also available in: API [`PATCH /emails/{id}`](https://openemail.uk/docs/api/reference/emails#patch-emails-id); CLI [`openemail emails reschedule`](https://openemail.uk/docs/cli/reference/emails#emails-reschedule).

### `emails.update()`

Change an email that has not gone yet

```ts
update(id: string, patch: EmailUpdate, options?: RequestScope): Promise<EmailResource>
```

Changes a `queued` or `scheduled` message before it is dispatched: when it goes with `scheduledAt`, what it says with `subject`, `html` and `text`, the address it goes out as with `from`, and who it goes to with `to`, `cc` and `bcc`. Send any of them together, and a field you leave out keeps its value. This is what editing a scheduled message in the calendar of the app does.

A recipient list replaces the stored one whole, and takes a string such as `Ada <ada@example.com>`, an object with `email` and `name`, or an array of either. `from` is checked as it is on a send, so it has to be an address the key may send as, or the call is a 403 `from_address_forbidden`.

Only messages that have not gone can change. Anything already `sending`, `sent`, `partial`, `cancelled` or `failed` is a 409 `email_not_cancellable`. A message translated when it was accepted keeps its approved wording, so a new `subject`, `html` or `text` on it is a 409 `translation_locked`, and one that was encrypted before it was scheduled keeps its wording and its recipients. Cancel those and send again instead.

Scopes: `emails:send`.

**Parameters**

- `id` (`string`, required): The `msg_` send id to change.
- `patch.scheduledAt` (`Date | string`): A new send time: a `Date`, an ISO 8601 instant or a duration such as `PT2H`, in the future and at most 365 days out.
- `patch.subject` (`string`): The new subject, up to 998 characters.
- `patch.html` (`string`): The new HTML body.
- `patch.text` (`string`): The new plain text body.
- `patch.from` (`string`): The address it goes out as instead, one the key may send as.
- `patch.to` (`RecipientInput | Array<RecipientInput>`): Replaces the recipients, at least one and at most 50 across the three lists.
- `patch.cc` (`RecipientInput | Array<RecipientInput>`): Replaces the copied recipients.
- `patch.bcc` (`RecipientInput | Array<RecipientInput>`): Replaces the blind copied recipients.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Changes it with this key instead of the client's.

**Returns**

`EmailResource`, the message as it is now. Its `subject`, `from` and `scheduledAt` show the change.

**Example**

```ts
const updated = await openemail.emails.update('msg_3f9a1c07d2b84e6a9c5b1f20', {
    subject: 'Your September invoice, corrected',
    to: ['ada@example.com', 'grace@example.com'],
    scheduledAt: new Date('2026-10-05T08:00:00Z')
})

console.log(updated.status, updated.subject, updated.scheduledAt)
```

**Notes**

- The SDK retries this call after a network failure, which is safe because a repeat writes the same values.
- An `email.updated` event naming the changed fields is added to the trail, and a move adds `email.rescheduled` as well.
- `reschedule` is the same call with only `scheduledAt`.

Also available in: API [`PATCH /emails/{id}`](https://openemail.uk/docs/api/reference/emails#patch-emails-id); CLI [`openemail emails update`](https://openemail.uk/docs/cli/reference/emails#emails-update).

### `emails.compose()`

Write an email with AI

```ts
compose(body: EmailCompose, options?: RequestScope): Promise<EmailCompositionResource>
```

Writes the body of an email from `prompt`, an instruction, a rough draft or a few notes, in the style of the mail this workspace has sent before, as the composer of the app does. `subject`, `to` and `cc` help the greeting and the tone fit.

Give `threadId` to write a reply: the messages of that thread are read as context, which also needs `threads:read`, and a key limited to particular addresses can only use a thread that arrived at them.

Nothing is saved or sent. Pass `body` to `emails.send` or `drafts.create` when it reads right. Each call spends one of the workspace's AI actions, and a workspace that has used them all for the day is refused with a 429 `ai_quota_exceeded`.

Scopes: `emails:send`.

**Parameters**

- `body.prompt` (`string`, required): What to write, up to 20,000 characters.
- `body.subject` (`string`): The subject so far, if there is one.
- `body.to` (`Array<string>`): Who it goes to.
- `body.cc` (`Array<string>`): Who is copied.
- `body.threadId` (`string`): A thread to reply in, read as context.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Overrides the client's API key for this call only.

**Returns**

`EmailCompositionResource`, `{ object: 'composition', body }`.

**Example**

```ts
const { body } = await openemail.emails.compose({
    prompt: 'Thank Ada for the signed contract and ask for the invoice by Friday.',
    to: ['ada@example.com']
})

await openemail.drafts.create({ to: ['ada@example.com'], subject: 'Thank you', text: body })
```

**Notes**

- The SDK does not retry it, because a second call writes something different and spends a second AI action.
- A server with no AI configured answers 409 `ai_not_configured`.

Also available in: API [`POST /emails/compose`](https://openemail.uk/docs/api/reference/emails#post-emails-compose); CLI [`openemail emails compose`](https://openemail.uk/docs/cli/reference/emails#emails-compose).

### `emails.rewrite()`

Rewrite part of an email with AI

```ts
rewrite(body: EmailRewrite, options?: RequestScope): Promise<EmailRewriteResource>
```

Rewrites a subject or a body and resolves different versions of it, as the rewrite menu of the composer does. `action` is `shorten`, `lengthen`, `rephrase`, `formal`, `casual` or `custom`, and `custom` needs `instruction` to say what to change, or the call is a 422 `invalid_parameter` on `instruction`. `target` is `body`, the default, or `subject`, and `count` asks for 1 to 5 versions, 3 by default.

Give `threadId` when the text is a reply, so the rewrite fits the conversation. That also needs `threads:read`. The versions never repeat the original and never add facts that are not in it.

Nothing is saved. Each call spends one of the workspace's AI actions.

Scopes: `emails:send`.

**Parameters**

- `body.text` (`string`, required): The subject or body to rewrite.
- `body.action` (`RewriteAction`, required): What to do: `shorten`, `lengthen`, `rephrase`, `formal`, `casual` or `custom`.
- `body.target` (`RewriteTarget`): `body` or `subject`. Defaults to `body`.
- `body.instruction` (`string`): What to change, up to 500 characters. Required with `custom`.
- `body.count` (`number`): How many versions, 1 to 5. Defaults to 3.
- `body.threadId` (`string`): The thread the text replies in, read as context.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Overrides the client's API key for this call only.

**Returns**

`EmailRewriteResource`, `{ object: 'rewrite', target, variations }`.

**Example**

```ts
const { variations } = await openemail.emails.rewrite({
    text: 'Hey, just checking whether you had a chance to look at the contract?',
    action: 'formal'
})

for (const version of variations) console.log(version)
```

**Notes**

- The SDK does not retry it, because a second call spends a second AI action.
- Fewer versions than `count` can come back when two of them turned out the same.

Also available in: API [`POST /emails/rewrite`](https://openemail.uk/docs/api/reference/emails#post-emails-rewrite); CLI [`openemail emails rewrite`](https://openemail.uk/docs/cli/reference/emails#emails-rewrite).

### `emails.suggestSubject()`

Suggest a subject line

```ts
suggestSubject(body: EmailSubject, options?: RequestScope): Promise<SubjectSuggestionResource>
```

Reads the body of an email and resolves a short subject for it, under 100 characters, in the style of the mail this workspace has sent, as the subject button of the composer does.

Nothing is saved. Each call spends one of the workspace's AI actions.

Scopes: `emails:send`.

**Parameters**

- `body.message` (`string`, required): The body of the email, as text or HTML.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Overrides the client's API key for this call only.

**Returns**

`SubjectSuggestionResource`, `{ object: 'subject_suggestion', subject }`.

**Example**

```ts
const { subject } = await openemail.emails.suggestSubject({
    message: 'Thanks for the signed contract. Could you send the invoice by Friday?'
})

console.log(subject)
```

**Notes**

- The SDK does not retry it, because a second call spends a second AI action.

Also available in: API [`POST /emails/subject`](https://openemail.uk/docs/api/reference/emails#post-emails-subject); CLI [`openemail emails suggest-subject`](https://openemail.uk/docs/cli/reference/emails#emails-suggest-subject).