Skip to main content

Module api

Module api 

Source
Expand description

JMAP API server

This module implements the JMAP (JSON Meta Application Protocol) API server as defined in RFC 8620. It provides comprehensive request validation including:

  • Request structure validation (using, methodCalls)
  • Capability validation (ensuring declared capabilities are supported)
  • Method call validation (structure, limits, arguments)
  • Error responses per RFC 8620 Section 3.6:
    • unknownCapability: Capability not recognized
    • notRequest: Request doesn’t match JMAP structure
    • limit: Server limit exceeded (e.g., maxCallsInRequest)
    • unknownMethod: Method not recognized
    • invalidArguments: Invalid method arguments
    • Other error types for account/server issues

Structs§

JmapServer
JMAP server