JMAP API Reference

Serverless Inbox implements JMAP (RFC 8620) and JMAP for Mail (RFC 8621).

Protocol overview

Endpoint: POST /jmap

All requests use a single endpoint. The body is a JSON object containing a using array (capability URIs) and a methodCalls array. Each method call is a 3-tuple [methodName, arguments, clientId].

Supported capabilities:

urn:ietf:params:jmap:core
urn:ietf:params:jmap:mail
urn:ietf:params:jmap:submission
urn:ietf:params:jmap:contacts
urn:ietf:params:jmap:principals
https://specs.serverlessinbox.com/page-token
https://specs.serverlessinbox.com/websocket

Result references

Method arguments can reference a previous result in the same request by prefixing the argument key with #. For example, pass "#ids": { "resultOf": "r1", "name": "Email/query", "path": "/ids" } to use the ids from an Email/query call with client ID r1.

Methods

Method	Object type	Verb
`Mailbox/get`	Mailbox	get
`Mailbox/changes`	Mailbox	changes
`Email/get`	Email	get
`Email/changes`	Email	changes
`Email/query`	Email	query
`Email/queryChanges`	Email	queryChanges
`Email/set`	Email	set
`Thread/get`	Thread	get
`Mailbox/set`	Mailbox	set
`Mailbox/query`	Mailbox	query
`Email/import`	Email	import
`Email/copy`	Email	copy
`Email/parse`	Email	parse
`Thread/query`	Thread	query
`Thread/changes`	Thread	changes
`EmailSubmission/get`	EmailSubmission	get
`EmailSubmission/set`	EmailSubmission	set
`EmailSubmission/query`	EmailSubmission	query
`EmailSubmission/queryChanges`	EmailSubmission	queryChanges
`EmailSubmission/changes`	EmailSubmission	changes
`Identity/get`	Identity	get
`Identity/set`	Identity	set
`Identity/changes`	Identity	changes
`Mailbox/queryChanges`	Mailbox	queryChanges
`Thread/queryChanges`	Thread	queryChanges
`AddressBook/get`	AddressBook	get
`AddressBook/set`	AddressBook	set
`AddressBook/query`	AddressBook	query
`AddressBook/queryChanges`	AddressBook	queryChanges
`AddressBook/changes`	AddressBook	changes
`ContactCard/get`	ContactCard	get
`ContactCard/set`	ContactCard	set
`ContactCard/query`	ContactCard	query
`ContactCard/queryChanges`	ContactCard	queryChanges
`ContactCard/changes`	ContactCard	changes
`ContactCard/copy`	ContactCard	copy
`Principal/get`	Principal	get
`Principal/set`	Principal	set
`Principal/query`	Principal	query
`Principal/queryChanges`	Principal	queryChanges
`Principal/changes`	Principal	changes
`ShareNotification/get`	ShareNotification	get
`ShareNotification/set`	ShareNotification	set
`ShareNotification/query`	ShareNotification	query
`ShareNotification/queryChanges`	ShareNotification	queryChanges
`ShareNotification/changes`	ShareNotification	changes