Expand description
JMAP Chat extension method handlers.
§Usage
Implement ChatBackend for your storage layer, then call
register_chat_handlers to wire all method names into a
jmap_server::Dispatcher:
let mut dispatcher: Dispatcher<()> = Dispatcher::new();
register_chat_handlers(&mut dispatcher, Arc::new(backend));§memory feature (reference implementation)
Enable the memory feature to expose the memory::MemoryBackend
reference implementation of ChatBackend. This is the same
backend used by this crate’s own integration tests, intended for
downstream contributors to study and for smoke tests / examples
that do not want to stand up a real database. Not production.
API stability is opt-in via this feature and may break across minor
versions while the crate is pre-1.0.
§Permission enforcement: backend canonical
All Space/set permission gates live in the backend’s
apply_space_patch implementation (see memory::MemoryBackend
under the memory feature for the reference impl). The handler
handle_space_set does NOT permission-check.
The pure helper required_permissions_for_op in permissions
maps each SpacePatchOp variant to its required permission strings
per draft-atwood-jmap-chat-00 §Space/set. Backends consume this
helper inside apply_space_patch after resolving the caller’s
effective permissions from the Space members entry whose id is
the accountId (the owner, per draft §Terminology). The gates apply
whether or not jmap_server::JmapBackend::principal_id resolves a
caller identity.
Handlers MUST NOT consume the helper for gating — backends are the
single source of truth. This mirrors the workspace-wide rule
documented in workspace AGENTS.md “Caller identity (foundation
seam)”:
- Handlers do NO permission checking.
- Defense-in-depth handler pre-checks are allowed but the backend MUST re-verify atomically with the mutation.
Re-exports§
pub use backend::ChatBackend;pub use backend::ChatLimits;pub use backend::EmojiSetOp;pub use backend::InviteJoinRefusal;pub use backend::OpResult;pub use backend::SlowModeError;pub use ban::handle_ban_changes;pub use ban::handle_ban_get;pub use ban::handle_ban_set;pub use chat::handle_chat_changes;pub use chat::handle_chat_get;pub use chat::handle_chat_query;pub use chat::handle_chat_query_changes;pub use chat::handle_chat_set;pub use chat::handle_chat_typing;pub use contact::handle_contact_changes;pub use contact::handle_contact_get;pub use contact::handle_contact_query;pub use contact::handle_contact_query_changes;pub use contact::handle_contact_set;pub use emoji::handle_emoji_changes;pub use emoji::handle_emoji_get;pub use emoji::handle_emoji_query;pub use emoji::handle_emoji_query_changes;pub use emoji::handle_emoji_set;pub use invite::handle_invite_changes;pub use invite::handle_invite_get;pub use invite::handle_invite_set;pub use message::handle_message_changes;pub use message::handle_message_get;pub use message::handle_message_query;pub use message::handle_message_query_changes;pub use message::handle_message_set;pub use permissions::required_permissions_for_op;pub use permissions::RequiredPermissions;pub use permissions::BAN;pub use permissions::MANAGE_CHANNELS;pub use permissions::MANAGE_MEMBERS;pub use permissions::MANAGE_ROLES;pub use permissions::MANAGE_SPACE;pub use permissions::PIN;pub use position::handle_position_changes;pub use position::handle_position_get;pub use position::handle_position_set;pub use presence::handle_presence_changes;pub use presence::handle_presence_get;pub use presence::handle_presence_set;pub use push::build_chat_message_push;pub use push::chat_state_change_for;pub use push::should_push;pub use push::strip_unsupported_chat_push;pub use push::validate_chat_push;pub use push::BuiltPush;pub use push::OwnerFlags;pub use push::PushItem;pub use space::handle_space_changes;pub use space::handle_space_get;pub use space::handle_space_join;pub use space::handle_space_query;pub use space::handle_space_query_changes;pub use space::handle_space_set;
Modules§
- backend
- ChatBackend trait and supporting types for JMAP Chat method handlers.
- ban
- SpaceBan/* method handlers (draft-atwood-jmap-chat-00 §SpaceBan).
- chat
- Chat/* method handlers (draft-atwood-jmap-chat-00 §Chat).
- contact
- ChatContact/* method handlers (draft-atwood-jmap-chat-00 §ChatContact).
- emoji
- CustomEmoji/* method handlers (draft-atwood-jmap-chat-00 §CustomEmoji).
- invite
- SpaceInvite/* method handlers (draft-atwood-jmap-chat-00 §SpaceInvite).
- message
- Message/* method handlers (draft-atwood-jmap-chat-00 §Message).
- permissions
- Pure permission-vocabulary helpers for backend authorization gating.
- position
- ReadPosition/* method handlers (draft-atwood-jmap-chat-00 §ReadPosition).
- presence
- PresenceStatus/* method handlers (draft-atwood-jmap-chat-00 §PresenceStatus).
- push
chatPushsupport for RFC 8620 push subscriptions (draft-atwood-jmap-chat-push-00).- space
- Space/* method handlers (draft-atwood-jmap-chat-00 §Space).
Structs§
- Added
Item - One entry in the
addedlist of a/queryChangesresponse (RFC 8620 §5.6). - Changes
Result - Result of a
/changescall (RFC 8620 §5.2). - Closure
Handler - Generic closure-to-
JmapHandleradapter fromjmap_server. - Query
Changes Result - Result of a
/queryChangescall (RFC 8620 §5.6). - Query
Result - Result of a
/querycall (RFC 8620 §5.5). - SetError
- A per-item error in a
/setresponse (notCreated,notUpdated,notDestroyedmaps) (RFC 8620 §5.3). - Space
Metadata Patch - A typed view of the five top-level metadata fields that
Space/setupdatecan mutate (draft-atwood-jmap-chat-00 §Space/set, fieldsname,description,iconBlobId,isPublic,isPubliclyPreviewable).
Enums§
- Backend
Changes Error - Error type returned by
JmapBackend::get_changesandJmapBackend::query_changes. - Backend
Query Error - Error type returned by
JmapBackend::query_objects. - Backend
SetError - Error type returned by create/update/destroy backend methods.
- Chat
Contact Property - Property selector for
crate::ChatContact/getand/set. - Chat
Property - Property selector for
crate::Chat/getand/set. - Message
Property - Property selector for
crate::Message/getand/set. - Read
Position Property - Property selector for
crate::ReadPosition/getand/set. - SetError
Type - The machine-readable type for a
SetError(RFC 8620 §5.3 and RFC 8621). - Space
Patch Op - A single Space/set update mutation operation.
- Space
Property - Property selector for
crate::Space/getand/set.
Traits§
- GetObject
- Marker for object types that support
getandchangesoperations. - Jmap
Backend - Read-side backend supertrait shared by all JMAP server crates.
- Jmap
Object - Marker trait for all JMAP object types.
- Query
Object - Marker for object types that support
queryandqueryChangesoperations. - SetObject
- Marker for object types that support
set(create/update/destroy) operations.
Functions§
- register_
chat_ handlers - Register all JMAP Chat method handlers with
dispatcher.