Struct Session 

#[non_exhaustive]
pub struct Session {
    pub capabilities: HashMap<String, Value>,
    pub accounts: HashMap<String, AccountInfo>,
    pub primary_accounts: HashMap<String, String>,
    pub username: String,
    pub api_url: String,
    pub download_url: String,
    pub upload_url: String,
    pub event_source_url: String,
    pub state: State,
}

JMAP Session object returned by GET /.well-known/jmap (RFC 8620 §2).

Contains only the base RFC 8620 fields. Extension-specific fields (e.g. JMAP Chat ownerUserId) are surfaced by extension crates that parse the capabilities and accounts maps.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

capabilities: HashMap<String, Value>

Map of capability URI → capability object (RFC 8620 §2).

Values are kept as raw JSON so callers can extract extension-specific capability objects without this crate knowing their schema.

accounts: HashMap<String, AccountInfo>

Map of account ID → AccountInfo (RFC 8620 §2).

primary_accounts: HashMap<String, String>

Map of capability URI → primary account ID (RFC 8620 §2).

username: String

Username associated with the current credentials (RFC 8620 §2).

api_url: String

URL for JMAP API POST requests (RFC 8620 §2).

download_url: String

URL template for blob downloads (RFC 8620 §2).

URI Template (level 1) containing variables accountId, blobId, type, and name.

upload_url: String

URL template for blob uploads (RFC 8620 §2).

URI Template (level 1) containing variable accountId.

event_source_url: String

URL template for SSE push event stream (RFC 8620 §2, §7.3).

URI Template (level 1) containing variables types, closeafter, and ping.

state: State

Opaque session state token (RFC 8620 §2).

Changes whenever any session property changes. Returned in every API response as sessionState; clients compare to detect staleness.

Implementations

impl Session

pub fn primary_account_id(&self, capability: &str) -> Option<&str>

Returns the primary account ID for the given capability URI, if set.

Example: session.primary_account_id("urn:ietf:params:jmap:mail")

pub fn websocket_capability( &self, ) -> Result<Option<WebSocketCapability>, ClientError>

Returns the parsed WebSocketCapability for the JMAP WebSocket transport, if advertised (RFC 8887).

• Ok(None) — server does not advertise JMAP WebSocket support.
• Ok(Some(...)) — WebSocket is supported; use result.url to connect.
• Err — capability key is present but the value is malformed.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Session

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Session

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Session

fn eq(&self, other: &Session) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Session