Stream mailbox events
Streams bounded rich mailbox events for connected clients. Each received-message event includes subject, participants, preview, attachment metadata, and a capped body snapshot; use the message endpoints for full content or attachment bytes.
Authorizations
Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.
Headers
Query Parameters
Comma-separated list: message.received, message.received.spam.
10 <= x <= 30030 <= x <= 3600Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
Response
Server-sent event stream. Event data uses the MailboxRealtimeEvent shape.
message.received, message.received.spam, sync_required provider, rfc5322