io-jmap 0.2.1

JMAP client library for Rust
Documentation

I/O JMAP Documentation Matrix Mastodon

JMAP client library for Rust

This library is composed of 3 feature-gated layers:

  • Low-level I/O-free coroutines: no_std-compatible state machines containing the whole JMAP logic, usable anywhere
  • Mid-level light client: a standard, blocking client wrapping a stream you opened yourself
  • High-level full client: the light client plus TCP connections and TLS negotiations handled for you

Table of contents

Features

  • Session discovery: resolves the JMAP session from a base URL or the well-known endpoint, surfacing redirects to the caller instead of following them.
  • Core protocol: batched method calls, generic get, set, query and changes flows, blob upload and download.
  • Push notifications: push subscription management and the streaming Event Source channel, yielding one state change per push frame with cooperative shutdown.
  • Mail: mailboxes, emails, threads, identities, email submissions and vacation responses.
  • Contacts: address books and contact cards, the JSContact payload kept as raw JSON.
  • Full standard, blocking client with TLS support:
    • Rustls with ring crypto (requires rustls-ring feature, enabled by default)
    • Rustls with aws crypto (requires rustls-aws feature)
    • Native TLS (requires native-tls feature)

[!TIP] I/O JMAP is written in Rust and uses cargo features to gate the client layers. The default feature set is declared in Cargo.toml or on docs.rs.

RFC coverage

RFC What is covered
8620 JMAP core: session discovery, batched API requests, generic get, set, query and changes methods, blobs, push (Event Source, PushSubscription)
8621 JMAP for Mail: Mailbox, Email, Thread, Identity, EmailSubmission, VacationResponse
9610 JMAP for Contacts: AddressBook, ContactCard (JSContact payload kept as raw JSON)

Usage

The whole API is documented on docs.rs, including runnable snippets for every coroutine and client.

Examples

Complete runnable programs live in ./examples; the tests also demonstrate real usage against live JMAP servers.

AI disclosure

This project is developed with AI assistance. This section documents how, so users and downstream packagers can make informed decisions.

  • Tools: Claude Code (Anthropic), invoked locally with a persistent project-scoped memory and a small set of repo-specific rules.
  • Used for: Refactors, mechanical multi-file edits, boilerplate (feature gates, error enums, derive macros, trait impls), test scaffolding, doc polish, exploratory design conversations.
  • Not used for: Engineering, critical code, git manipulation (commit, merge, rebase…), real-world tests.
  • Verification: Every AI-assisted change is read, compiled, tested, and formatted before commit. Behavioural correctness is verified against the relevant RFC or upstream spec, not assumed from the model output. Tests are never adjusted to fit AI-generated code; the code is adjusted to fit correct behaviour.
  • Limitations: AI models occasionally produce code that compiles and passes tests but is subtly wrong. The verification workflow catches most of this; it does not catch all of it. Bug reports are welcome and taken seriously.
  • Last reviewed: 15/07/2026

License

This project is licensed under either of:

at your option.

Social

Contributing

Contributions are welcome: start with CONTRIBUTING.md, which opens with the Pimalaya-wide guides to read first.

Sponsoring

nlnet

Special thanks to the NLnet foundation and the European Commission that have been financially supporting the project for years:

If you appreciate the project, feel free to donate using one of the following providers:

GitHub Ko-fi Buy Me a Coffee Liberapay thanks.dev PayPal