Sign in
Mailbox API

Stream mailbox events

Changed on

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.

get/mailbox/events

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/events
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.read)

Query parameters

mailbox_idstring

Select a granted mailbox when using an OAuth token with multiple mailboxes.

event_typesstring

Comma-separated list: message.received, message.received.spam.

last_event_idstring
pinginteger
close_afterinteger

Headers

Last-Event-IDstring

Response

Server-sent event stream. Event data uses the MailboxRealtimeEvent shape.

Changes

  • b42ce87003aeRevision changes
    • info

      removed subschema #2 from the / response property allOf list for the response status

    • info

      added subschema #2 to the / response property anyOf list for the response status

  • b901839a0d8bRevision changes
    • breaking

      the response property became nullable for the status

    • info

      added the optional property / to the response with the status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status