nextmail live-events

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.

Prints each event as one JSON object per line the moment it arrives, on a terminal, in a pipe and with --json alike, and keeps going until you press Ctrl+C. --max <n> stops after that many events.