Escape Public API — Emails

naftiko: 1.0.0-alpha2
info:
  label: Escape Public API — Emails
  description: 'Escape Public API — Emails. 2 operations. Lead operation: List inbox emails. Self-contained Naftiko capability
    covering one Escape business surface.'
  tags:
  - Escape
  - Emails
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ESCAPE_API_KEY: ESCAPE_API_KEY
capability:
  consumes:
  - type: http
    namespace: escape-emails
    baseUri: https://public.escape.tech/v3
    description: Escape Public API — Emails business capability. Self-contained, no shared references.
    resources:
    - name: scans-emails
      path: /scans/emails
      operations:
      - name: listinboxemails
        method: GET
        description: List inbox emails
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cursor
          in: query
          type: string
          description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the
            first page will be returned.
        - name: size
          in: query
          type: integer
          description: The number of items to return per page
        - name: ids
          in: query
          type: array
          description: Filter by email IDs
        - name: before
          in: query
          type: string
          description: Filter by before date
        - name: after
          in: query
          type: string
          description: Filter by after date
        - name: email
          in: query
          type: string
          description: Inbox email address used as `to` filter
          required: true
    - name: scans-emails-id
      path: /scans/emails/{id}
      operations:
      - name: readinboxemail
        method: GET
        description: Read inbox email content
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The inbox email ID
          required: true
    authentication:
      type: apikey
      key: X-ESCAPE-API-KEY
      value: '{{env.ESCAPE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: escape-emails-rest
    port: 8080
    description: REST adapter for Escape Public API — Emails. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/scans/emails
      name: scans-emails
      description: REST surface for scans-emails.
      operations:
      - method: GET
        name: listinboxemails
        description: List inbox emails
        call: escape-emails.listinboxemails
        with:
          cursor: rest.cursor
          size: rest.size
          ids: rest.ids
          before: rest.before
          after: rest.after
          email: rest.email
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scans/emails/{id}
      name: scans-emails-id
      description: REST surface for scans-emails-id.
      operations:
      - method: GET
        name: readinboxemail
        description: Read inbox email content
        call: escape-emails.readinboxemail
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: escape-emails-mcp
    port: 9090
    transport: http
    description: MCP adapter for Escape Public API — Emails. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-inbox-emails
      description: List inbox emails
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: escape-emails.listinboxemails
      with:
        cursor: tools.cursor
        size: tools.size
        ids: tools.ids
        before: tools.before
        after: tools.after
        email: tools.email
      outputParameters:
      - type: object
        mapping: $.
    - name: read-inbox-email-content
      description: Read inbox email content
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: escape-emails.readinboxemail
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.