Struct JmapClientStd 

pub struct JmapClientStd {
    pub stream: Box<dyn JmapStream>,
    pub http_auth: SecretString,
    pub session: Option<JmapSession>,
}

Available on crate feature client only.

Std-blocking JMAP client wrapping a single boxed stream.

Fields

stream: Box<dyn JmapStream>

http_auth: SecretString

session: Option<JmapSession>

Implementations

impl JmapClientStd

pub fn new<S: Read + Write + Send + 'static>( stream: S, http_auth: SecretString, ) -> Self

Builds a client around stream. The caller is responsible for opening the connection (TCP, TLS handshake if needed) and for the bearer token / authorization header value.

pub fn run<C, T, E>(&mut self, coroutine: C) -> Result<T, JmapClientStdError>

where C: JmapCoroutine<Yield = JmapYield, Return = Result<T, E>>, JmapClientStdError: From<E>,

Drives any standard-shape coroutine (Yield = JmapYield) against the wrapped stream until it terminates.

Redirect-aware coroutines (JmapSessionGet, JmapBlobUpload, JmapBlobDownload) and the streaming JmapEventSource have their own per-method loops.

pub fn from_parts<S: Read + Write + Send + 'static>( stream: S, http_auth: SecretString, session: JmapSession, ) -> Self

Builds a client from a pre-connected stream and an already-discovered JmapSession. Skips Self::session_get.

pub fn connect( url: &Url, tls: &Tls, http_auth: SecretString, ) -> Result<Self, JmapClientStdError>

Available on crate features native-tls or rustls-aws or rustls-ring only.

Connects to url, doing a TLS handshake for https / jmaps (plain TCP for http / jmap). ALPN comes from tls.rustls.alpn (see default_alpn); empty vec skips ALPN.

pub fn set_stream<S: Read + Write + Send + 'static>(&mut self, stream: S)

Replaces the underlying stream; useful when apiUrl, uploadUrl or downloadUrl resolves to a different authority than the first connection target, or after a redirect.

pub fn session(&self) -> Option<&JmapSession>

Returns the cached session, if Self::session_get has run.

pub fn http_auth(&self) -> &SecretString

Returns the pre-formatted HTTP Authorization header value.

pub fn session_get( &mut self, url: &Url, ) -> Result<&JmapSession, JmapClientStdError>

Runs JmapSessionGet and caches the discovered session.

url is either a base URL for /.well-known/jmap discovery or a direct session endpoint. A 3xx response terminates with JmapClientStdError::UnexpectedRedirect.

pub fn send_raw( &mut self, request: JmapRequest, ) -> Result<JmapResponse, JmapClientStdError>

Sends a raw JMAP request and returns the raw JmapResponse. Useful for passthrough CLIs and ad-hoc requests with custom using capabilities.

pub fn blob_upload( &mut self, upload_url: &Url, content_type: &str, data: Vec<u8>, ) -> Result<JmapBlobUploadOutput, JmapClientStdError>

Uploads a blob to upload_url (RFC 8620 §6.1). The caller must resolve the session’s uploadUrl template (e.g. substitute {accountId}). A 3xx response terminates with JmapClientStdError::UnexpectedRedirect.

pub fn blob_download( &mut self, download_url: &Url, ) -> Result<Vec<u8>, JmapClientStdError>

Downloads a blob from download_url (RFC 8620 §6.2). The caller must resolve the session’s downloadUrl template. A 3xx response terminates with JmapClientStdError::UnexpectedRedirect.

pub fn mailbox_get( &mut self, opts: JmapMailboxGetOptions, ) -> Result<JmapMailboxGetOutput, JmapClientStdError>

Runs JmapMailboxGet (Mailbox/get).

pub fn mailbox_query( &mut self, opts: JmapMailboxQueryOptions, ) -> Result<JmapMailboxQueryOutput, JmapClientStdError>

Runs JmapMailboxQuery (batched Mailbox/query + Mailbox/get).

pub fn mailbox_set( &mut self, args: JmapMailboxSetArgs, ) -> Result<JmapMailboxSetOutput, JmapClientStdError>

Runs JmapMailboxSet (Mailbox/set).

pub fn mailbox_changes( &mut self, since_state: impl Into<String>, opts: JmapMailboxChangesOptions, ) -> Result<JmapChangesOutput, JmapClientStdError>

Runs JmapMailboxChanges (Mailbox/changes).

pub fn email_get( &mut self, ids: Vec<String>, opts: JmapEmailGetOptions, ) -> Result<JmapEmailGetOutput, JmapClientStdError>

Runs JmapEmailGet (Email/get).

pub fn email_query( &mut self, opts: JmapEmailQueryOptions, ) -> Result<JmapEmailQueryOutput, JmapClientStdError>

Runs JmapEmailQuery (batched Email/query + Email/get).

pub fn email_set( &mut self, args: JmapEmailSetArgs, ) -> Result<JmapEmailSetOutput, JmapClientStdError>

Runs JmapEmailSet (Email/set).

pub fn email_changes( &mut self, since_state: impl Into<String>, opts: JmapEmailChangesOptions, ) -> Result<JmapChangesOutput, JmapClientStdError>

Runs JmapEmailChanges (Email/changes).

pub fn email_copy( &mut self, from_account_id: impl Into<String>, emails: BTreeMap<String, JmapEmailCopyArgs>, ) -> Result<JmapEmailCopyOutput, JmapClientStdError>

Runs JmapEmailCopy (Email/copy).

pub fn email_import( &mut self, emails: BTreeMap<String, JmapEmailImportArgs>, ) -> Result<JmapEmailImportOutput, JmapClientStdError>

Runs JmapEmailImport (Email/import).

pub fn email_parse( &mut self, blob_ids: Vec<String>, opts: JmapEmailParseOptions, ) -> Result<JmapEmailParseOutput, JmapClientStdError>

Runs JmapEmailParse (Email/parse).

pub fn thread_get( &mut self, ids: Vec<String>, ) -> Result<JmapThreadGetOutput, JmapClientStdError>

Runs JmapThreadGet (Thread/get).

pub fn thread_changes( &mut self, since_state: impl Into<String>, opts: JmapThreadChangesOptions, ) -> Result<JmapChangesOutput, JmapClientStdError>

Runs JmapThreadChanges (Thread/changes).

pub fn identity_get( &mut self, opts: JmapIdentityGetOptions, ) -> Result<JmapIdentityGetOutput, JmapClientStdError>

Runs JmapIdentityGet (Identity/get).

pub fn identity_set( &mut self, args: JmapIdentitySetArgs, ) -> Result<JmapIdentitySetOutput, JmapClientStdError>

Runs JmapIdentitySet (Identity/set).

pub fn email_submission_get( &mut self, opts: JmapEmailSubmissionGetOptions, ) -> Result<JmapEmailSubmissionGetOutput, JmapClientStdError>

Runs JmapEmailSubmissionGet (EmailSubmission/get).

pub fn email_submission_query( &mut self, opts: JmapEmailSubmissionQueryOptions, ) -> Result<JmapEmailSubmissionQueryOutput, JmapClientStdError>

Runs JmapEmailSubmissionQuery (batched EmailSubmission/query + EmailSubmission/get).

pub fn email_submission_set( &mut self, submissions: BTreeMap<String, JmapEmailSubmissionCreate>, ) -> Result<JmapEmailSubmissionSetOutput, JmapClientStdError>

Runs JmapEmailSubmissionSet (EmailSubmission/set).

pub fn email_submission_cancel( &mut self, ids: Vec<String>, ) -> Result<JmapEmailSubmissionCancelOutput, JmapClientStdError>

Runs JmapEmailSubmissionCancel (EmailSubmission/set with undoStatus: "canceled").

pub fn vacation_response_get( &mut self, ) -> Result<Option<JmapVacationResponse>, JmapClientStdError>

Runs JmapVacationResponseGet; returns the singleton, if any.

pub fn vacation_response_set( &mut self, patch: JmapVacationResponseUpdate, ) -> Result<Option<JmapVacationResponse>, JmapClientStdError>

Runs JmapVacationResponseSet; returns the updated singleton if the server echoed it back.

Trait Implementations

impl Debug for JmapClientStd

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

Formats the value using the given formatter.