> ## Documentation Index
> Fetch the complete documentation index at: https://sendmux.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /openapi-app.json get /mailbox/events
openapi: 3.1.0
info:
  description: Programmatic access to your Sendmux email infrastructure.
  title: Sendmux API
  version: 1.0.0
servers:
  - description: API v1
    url: https://app.sendmux.ai/api/v1
security:
  - bearerAuth: []
paths:
  /mailbox/events:
    get:
      tags:
        - Mailbox API
      summary: Stream mailbox events
      description: >-
        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.
      operationId: mailboxStreamEvents
      parameters:
        - in: query
          name: event_types
          required: false
          schema:
            description: 'Comma-separated list: message.received, message.received.spam.'
            type: string
        - in: query
          name: last_event_id
          required: false
          schema:
            type: string
        - in: query
          name: ping
          required: false
          schema:
            maximum: 300
            minimum: 10
            type: integer
        - in: query
          name: close_after
          required: false
          schema:
            maximum: 3600
            minimum: 30
            type: integer
        - in: header
          name: Last-Event-ID
          required: false
          schema:
            type: string
        - description: >-
            Mailbox public ID to target when the credential grants access to
            more than one mailbox. Omit when the credential is scoped to exactly
            one mailbox.
          in: query
          name: mailbox_id
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            text/event-stream:
              schema:
                $ref: '#/components/schemas/MailboxRealtimeEvent'
          description: >-
            Server-sent event stream. Event data uses the MailboxRealtimeEvent
            shape.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid stream parameters
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authentication required
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Mailbox API key required
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Too many realtime connections
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Realtime events unavailable
      security:
        - bearerAuth: []
components:
  schemas:
    MailboxRealtimeEvent:
      additionalProperties: false
      properties:
        event_type:
          enum:
            - message.received
            - message.received.spam
            - sync_required
          type: string
        is_spam:
          type:
            - boolean
            - 'null'
        mailbox_id:
          type: string
        message:
          $ref: '#/components/schemas/MailboxRealtimeMessage'
        message_id:
          type:
            - string
            - 'null'
        message_id_kind:
          enum:
            - provider
            - rfc5322
          type:
            - string
            - 'null'
        occurred_at:
          type: string
        recipients:
          items:
            type: string
          type: array
        sender:
          type:
            - string
            - 'null'
        team_public_id:
          type: string
      required:
        - event_type
        - team_public_id
        - mailbox_id
        - message_id
        - message_id_kind
        - sender
        - recipients
        - is_spam
        - message
        - occurred_at
      type: object
    ApiError:
      additionalProperties: false
      properties:
        error:
          additionalProperties: false
          properties:
            code:
              description: Machine-readable error code
              enum:
                - invalid_parameter
                - missing_parameter
                - authentication_required
                - insufficient_permissions
                - not_found
                - conflict
                - limit_exceeded
                - idempotency_conflict
                - payload_too_large
                - validation_error
                - rate_limit_exceeded
                - service_unavailable
                - internal_error
              example: invalid_parameter
              type: string
            doc_url:
              description: Link to relevant documentation
              type: string
            errors:
              description: >-
                Accumulated per-field issues for validation errors. Only present
                on 400/422 responses.
              items:
                $ref: '#/components/schemas/ApiErrorDetail'
              type: array
            message:
              description: Human-readable error description
              type: string
            param:
              description: The parameter that caused the error
              type: string
            retryable:
              description: >-
                Whether the caller may safely retry this request. 4xx are
                typically false (except 429); 5xx are typically true.
              example: false
              type: boolean
          required:
            - code
            - message
            - retryable
          type: object
        meta:
          additionalProperties: false
          properties:
            request_id:
              example: req_clxxxxxxxxxxxxxxxxxxxxxxxxx
              type: string
          required:
            - request_id
          type: object
        ok:
          enum:
            - false
          type: boolean
      required:
        - ok
        - error
        - meta
      type: object
    MailboxRealtimeMessage:
      allOf:
        - $ref: '#/components/schemas/MailboxMessageSummary'
        - additionalProperties: false
          properties:
            attachments:
              items:
                $ref: '#/components/schemas/MailboxAttachment'
              type: array
            body:
              additionalProperties: false
              properties:
                html:
                  type:
                    - string
                    - 'null'
                is_truncated:
                  type: boolean
                max_bytes:
                  type: integer
                text:
                  type:
                    - string
                    - 'null'
              required:
                - text
                - html
                - is_truncated
                - max_bytes
              type: object
            rfc5322_message_id:
              type:
                - string
                - 'null'
          required:
            - rfc5322_message_id
            - body
          type:
            - object
            - 'null'
    ApiErrorDetail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Machine-readable issue code from the validator (e.g. zod issue
            code).
          example: invalid_string
          type: string
        field:
          description: Dot-path of the offending request field.
          example: recipient.email
          type: string
        message:
          description: Human-readable issue description.
          type: string
      required:
        - field
        - code
        - message
      type: object
    MailboxMessageSummary:
      additionalProperties: false
      properties:
        attachments:
          description: >-
            Attachment metadata for this message. Each item includes a
            short-lived `download_url`; if it expires, fetch message metadata
            again.
          items:
            $ref: '#/components/schemas/MailboxAttachment'
          type: array
        bcc:
          items:
            $ref: '#/components/schemas/MailboxAddress'
          type: array
        cc:
          items:
            $ref: '#/components/schemas/MailboxAddress'
          type: array
        flags:
          $ref: '#/components/schemas/MailboxMessageFlags'
        folder_ids:
          items:
            type: string
          type: array
        from:
          allOf:
            - $ref: '#/components/schemas/MailboxAddress'
            - type:
                - object
                - 'null'
        has_attachments:
          type: boolean
        id:
          description: Message ID
          type: string
        keywords:
          description: Active message keywords, including system flags and custom labels.
          example:
            - $seen
            - $flagged
            - agent_triaged
          items:
            type: string
          type: array
        preview:
          type:
            - string
            - 'null'
        received_at:
          type:
            - string
            - 'null'
        sent_at:
          type:
            - string
            - 'null'
        size_bytes:
          type:
            - integer
            - 'null'
        subject:
          type:
            - string
            - 'null'
        thread_id:
          type:
            - string
            - 'null'
        to:
          items:
            $ref: '#/components/schemas/MailboxAddress'
          type: array
      required:
        - id
        - thread_id
        - folder_ids
        - subject
        - preview
        - from
        - to
        - cc
        - bcc
        - received_at
        - sent_at
        - size_bytes
        - has_attachments
        - keywords
        - flags
      type: object
    MailboxAttachment:
      additionalProperties: false
      properties:
        content_id:
          description: Content ID for inline attachments, when present.
          type:
            - string
            - 'null'
        content_type:
          example: application/pdf
          type: string
        disposition:
          example: attachment
          type:
            - string
            - 'null'
        download_url:
          description: >-
            Short-lived URL for this exact attachment. Fetch it promptly; if it
            expires, call the message or attachment metadata endpoint again to
            receive a fresh URL.
          example: >-
            https://app.sendmux.ai/api/v1/mailbox/messages/msg_123/attachment-downloads/attref_abc123?download_token=...
          type: string
        filename:
          example: invoice.pdf
          type:
            - string
            - 'null'
        id:
          description: Attachment blob ID.
          type: string
        size_bytes:
          example: 12345
          type:
            - integer
            - 'null'
      required:
        - id
        - filename
        - content_type
        - size_bytes
        - disposition
        - content_id
      type: object
    MailboxAddress:
      additionalProperties: false
      properties:
        email:
          example: agent@example.com
          format: email
          type: string
        name:
          example: Support
          type:
            - string
            - 'null'
      required:
        - email
        - name
      type: object
    MailboxMessageFlags:
      additionalProperties: false
      properties:
        answered:
          type: boolean
        draft:
          type: boolean
        flagged:
          type: boolean
        seen:
          type: boolean
      required:
        - seen
        - flagged
        - draft
        - answered
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: API Key
      description: >-
        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.
      scheme: bearer
      type: http

````