Struct M2dirClient 

pub struct M2dirClient {
    pub inner: M2dirClient,
}

Available on crate features client and m2dir only.

Light m2dir client wrapping a filesystem root.

The shared root lives on Self::inner; m2dir has no extra per-session knobs (no auto_select, no capability list).

Fields

inner: M2dirClient

Implementations

impl M2dirClient

pub fn new(root: impl Into<M2dirPath>) -> Self

Wraps a fresh inner client rooted at root. No filesystem check is performed at construction time.

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

where C: M2dirCoroutine<Yield = M2dirYield, Return = Result<T, E>>, M2dirClientError: From<E>,

Pumps any standard-shape m2dir coroutine (Yield = M2dirYield, Return = Result<T, E>) against the local filesystem until it terminates.

Duplicates the body of InnerM2dirClient::run so error variants route through M2dirClientError directly.

pub fn list_mailboxes( &self, with_counts: bool, ) -> Result<Vec<Mailbox>, M2dirClientError>

Lists every m2dir under the store root. with_counts is accepted for symmetry with the other backends; surfacing totals/unread needs a follow-up walk and is currently a no-op.

pub fn list_envelopes( &self, mailbox: &str, page: Option<u32>, page_size: Option<u32>, with_attachment: bool, ) -> Result<Vec<Envelope>, M2dirClientError>

Lists envelopes from mailbox. page = None and page_size = None fetch the whole mailbox; envelopes are sorted by date descending.

pub fn search_envelopes( &self, mailbox: &str, query: Option<&SearchEmailsQuery>, page: Option<u32>, page_size: Option<u32>, with_attachment: bool, ) -> Result<Vec<Envelope>, M2dirClientError>

Available on crate feature search only.

Searches envelopes in mailbox against the shared query. Filtering and sorting happen client-side after a full scan.

pub fn store_flags( &self, mailbox: &str, ids: &[&str], flags: &[Flag], op: FlagOp, ) -> Result<(), M2dirClientError>

Adds, sets, or removes flags on every id by rewriting each .meta/<id>.flags sidecar.

pub fn get_message( &self, mailbox: &str, id: &str, ) -> Result<Vec<u8>, M2dirClientError>

Reads one message’s raw bytes by id, validating the checksum embedded in its filename.

pub fn add_message( &self, mailbox: &str, flags: &[Flag], raw: Vec<u8>, ) -> Result<String, M2dirClientError>

Appends raw to mailbox, then persists flags as the .meta/<id>.flags sidecar when non-empty. Returns the minted entry id.

pub fn create_mailbox(&self, name: &str) -> Result<(), M2dirClientError>

Creates name as a new m2dir mailbox: the folder, the .m2dir marker and the .meta sub-directory.

pub fn delete_mailbox(&self, name: &str) -> Result<(), M2dirClientError>

Recursively removes the m2dir at name.

pub fn delete_message( &self, mailbox: &str, id: &str, ) -> Result<(), M2dirClientError>

Removes the entry id and every matching .meta/<id>* file.

pub fn copy_messages( &self, from: &str, to: &str, ids: &[&str], ) -> Result<(), M2dirClientError>

Copies every id from from to to. Flag sidecars are not propagated; callers add flags explicitly after the copy when needed.

pub fn move_messages( &self, from: &str, to: &str, ids: &[&str], ) -> Result<(), M2dirClientError>

Moves every id from from to to. Flag sidecars are not propagated; callers add flags explicitly after the move when needed.