jmap_mail_client/lib.rs
1//! jmap-mail-client — RFC 8621 JMAP for Mail method implementations.
2//!
3//! Depends on jmap-base-client for transport, auth, and session.
4//! See PLAN.md for the full implementation plan.
5//!
6//! # Usage
7//!
8//! ```rust,no_run
9//! # use jmap_mail_client::JmapMailExt;
10//! # async fn example(client: jmap_base_client::JmapClient) -> Result<(), jmap_base_client::ClientError> {
11//! let session = client.fetch_session().await?;
12//! let sc = client.with_mail_session(session);
13//! // Fetch Email metadata. None ids = fetch all (typically scoped via /query first).
14//! let emails = sc.email_get(None, None, None).await?;
15//! # let _ = emails;
16//! # Ok(())
17//! # }
18//! ```
19
20#![forbid(unsafe_code)]
21
22pub mod methods;
23
24pub use jmap_base_client::ClientError;
25pub use methods::{
26 AddedItem, ChangesResponse, EmailCopyParams, EmailGetParams, EmailImportCreated,
27 EmailImportInput, EmailImportResponse, EmailParseParams, EmailParseResponse,
28 EmailSubmissionSetParams, GetResponse, MailboxSetParams, QueryChangesResponse, QueryResponse,
29 SessionClient, SetError, SetResponse,
30};
31
32/// Extension trait adding RFC 8621 (JMAP for Mail) methods to [`jmap_base_client::JmapClient`].
33///
34/// Import this trait to use: `use jmap_mail_client::JmapMailExt;`
35///
36/// All JMAP Mail method calls are made through the [`SessionClient`] returned
37/// by [`with_mail_session`](JmapMailExt::with_mail_session).
38pub trait JmapMailExt {
39 /// Create a [`SessionClient`] bound to this client and session.
40 ///
41 /// All JMAP Mail method calls are made through the returned [`SessionClient`].
42 fn with_mail_session(&self, session: jmap_base_client::Session) -> methods::SessionClient;
43}
44
45impl JmapMailExt for jmap_base_client::JmapClient {
46 fn with_mail_session(&self, session: jmap_base_client::Session) -> methods::SessionClient {
47 methods::SessionClient {
48 client: self.clone(),
49 session,
50 }
51 }
52}