Skip to main content

Module methods

Module methods 

Source
Expand description

RFC 8620 §5 generic method-response shapes shared by all JMAP method types.

These wire types are normative — every JMAP /get, /set, /changes, /query, and /queryChanges method (across mail, calendars, contacts, chat, etc.) returns one of these shapes. Centralising them here avoids drift between the seven jmap-*-client crates that previously each defined their own copies. Server crates may still hand-build wire JSON for their /set responses (so they can use the typed SetErrorType enum at construction time); this crate’s SetError is the deserialization target on the client side.

All types use camelCase JSON via #[serde(rename_all = "camelCase")] and are marked #[non_exhaustive] so future RFC errata or extensions can add fields without a SemVer break.

§Spec references

TypeSpec
GetResponseRFC 8620 §5.1
ChangesResponseRFC 8620 §5.2
SetResponse, SetErrorRFC 8620 §5.3
QueryResponseRFC 8620 §5.5
QueryChangesResponse, AddedItemRFC 8620 §5.6

Structs§

AddedItem
A single item added to a query result set (RFC 8620 §5.6).
ChangesResponse
RFC 8620 §5.2 — Foo/changes response shape.
GetResponse
RFC 8620 §5.1 — Foo/get response shape.
QueryChangesResponse
RFC 8620 §5.6 — Foo/queryChanges response shape.
QueryResponse
RFC 8620 §5.5 — Foo/query response shape.
SetError
A per-item failure in a /set response (RFC 8620 §5.3).
SetResponse
RFC 8620 §5.3 — Foo/set response shape.