---
title: "nextmail.liveEvents"
description: "Every method in this namespace: its signature, its parameters, what it returns and an example."
url: "https://nextmail.sh/docs/sdk/reference/live-events"
area: "TypeScript"
category: "Reference"
---

# nextmail.liveEvents

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

## Methods

Follow the mailbox as it changes, without polling: one event each time a message arrives or is sent and each time a conversation changes or is deleted, resumed where it left off after a dropped connection.

### `liveEvents.stream()`

Follow the mailbox as it changes

```ts
stream(options?: LiveEventStreamOptions): AsyncGenerator<LiveEventResource, void, undefined>
```

Opens the live event stream, `GET /live-events` as server-sent events, and yields one event per step for as long as you read it: `message.received` when a message is filed for an address, `message.sent` when a message sent from an address is filed in its Sent folder, `thread.changed` when a conversation gains or loses labels (read, starred, archived, moved, snoozed or labelled), `thread.deleted` when one is deleted for good, and `message.status_changed` when the delivery of an email sent from an address moves on, with its `status`: `delivered`, `delivery_delayed`, `bounced`, `complained`, `failed`, `suppressed` or `cancelled`. Each event is `{ id, type, occurredAt, data }`, where `data.addresses` names the addresses it concerns and `threadId` and `messageId` the conversation and the message, where there is one. No content travels in an event, so read the conversation with `threads.get` or the message with `threads.getMessage` when you need it.

The stream never ends by itself. The server closes it after 30 minutes, when the credential stops being valid, or when the connection drops, and the generator opens it again and resumes where it left off through `Last-Event-ID`: at once after the server closes it, and with backoff after a failure. When the server can no longer replay from that point, which happens once the event is more than 10 minutes or 1,000 events back, the generator yields a `reset` event with `type: 'reset'` before the next events: anything may have changed in between, so list again what you keep in sync. Break out of the loop, or abort `options.signal`, to close it.

A key or an app limited to particular addresses gets only the events of the addresses it reaches, enforced on the server for every event.

Scopes: `threads:read`.

**Parameters**

- `options.types` (`Array<LiveEventType>`): Only these kinds of event: `message.received`, `message.sent`, `thread.changed`, `thread.deleted` and `message.status_changed`. Left out, all of them. A `reset` is always delivered.
- `options.address` (`string`): Only the events of this address. One the key does not reach delivers nothing rather than failing.
- `options.lastEventId` (`string`): Resume after this event id, one an earlier stream yielded. Left out, the stream starts with what happens from now on.
- `options.signal` (`AbortSignal`): Closes the stream and ends the generator.
- `options.apiKey` (`string`): Overrides the client's API key for this stream only.

**Returns**

`AsyncGenerator<LiveEventResource, void, undefined>` yielding each event as `{ id, type, occurredAt, data }`, with `data` `{ addresses, threadId, messageId }` and, by type, `labelIds` (received), `emailId` (sent), `addedLabelIds` and `removedLabelIds` (changed), or `emailId`, `status` and `recipients` (status changed, where `threadId` may be null). A `reset` yields `{ id, type: 'reset', occurredAt, data: { reason } }`.

**Example**

```ts
const controller = new AbortController()

for await (const event of nextmail.liveEvents.stream({ types: ['message.received'], signal: controller.signal })) {
    if (event.type === 'reset') {
        console.log('Resync: the stream could not resume')
        continue
    }

    if (event.type === 'message.received') {
        const thread = await nextmail.threads.get(event.data.threadId)

        console.log(event.data.addresses, thread.id)
    }
}
```

**Notes**

- One key, app or session holds at most 5 open streams, and a workspace at most 50. Past that the stream is refused with 429 `too_many_streams`.
- The server sends a keepalive every 25 seconds and a `retry` hint of 3 seconds. Events are kept for resuming for 10 minutes and at most 1,000 per workspace.
- A network failure, a 408, a 429 and a 5xx answer are retried for as long as you read, waiting about a second at first and doubling up to 30 seconds, or longer when `Retry-After` asks. When no byte arrives for 60 seconds, the generator drops the connection and opens it again.
- A 400, 401, 403, 404 or 422 throws the `NextmailApiError` instead of retrying, so an expired or revoked credential ends the stream on the next attempt to open it.

Also available in: API [`GET /live-events`](https://nextmail.sh/docs/api/reference/live-events#get-live-events); Python [`live_events.stream()`](https://nextmail.sh/docs/python/reference/live-events#stream); Ruby [`live_events.stream`](https://nextmail.sh/docs/ruby/reference/live-events#stream); PHP [`liveEvents->stream`](https://nextmail.sh/docs/php/reference/live-events#stream); Go [`LiveEvents.Stream`](https://nextmail.sh/docs/go/reference/live-events#stream); Java [`liveEvents().stream`](https://nextmail.sh/docs/java/reference/live-events#stream); C# [`LiveEvents.StreamAsync`](https://nextmail.sh/docs/csharp/reference/live-events#stream); CLI [`nextmail live-events stream`](https://nextmail.sh/docs/cli/reference/live-events#live-events-stream).