Struct Workspace 

pub struct Workspace { /* private fields */ }

Implementations

impl Workspace

pub fn create_archive_message_category( &self, name: &str, message_id: Option<&str>, summary: Option<&str>, reason: Option<&str>, ) -> Result<Value>

pub fn archive_list(&self) -> Result<Value>

pub fn archive_list_cases(&self) -> Result<Value>

pub fn archive_list_messages(&self) -> Result<Value>

pub fn archive_message_show(&self, archive_ref: &str) -> Result<Value>

pub fn archive_message_restore( &self, archive_ref: &str, message_id: &str, reason: Option<&str>, ) -> Result<Value>

pub fn archive_message_move( &self, archive_ref: &str, message_id: &str, new_archive_ref: &str, reason: Option<&str>, ) -> Result<Value>

pub fn archive_message_rename( &self, archive_ref: &str, name: &str, reason: Option<&str>, ) -> Result<Value>

pub fn archive_message_set_summary( &self, archive_ref: &str, message_id: &str, summary: &str, reason: Option<&str>, ) -> Result<Value>

pub fn archive_message_notes_show(&self, archive_ref: &str) -> Result<Value>

pub fn archive_message_notes_append( &self, archive_ref: &str, text: &str, ) -> Result<Value>

pub fn archive_message_notes_replace( &self, archive_ref: &str, text: &str, ) -> Result<Value>

impl Workspace

pub fn create_case( &self, name: &str, group: Option<&str>, message_id: Option<&str>, summary: Option<&str>, reason: Option<&str>, ) -> Result<Value>

pub fn add_message_to_case( &self, case_ref: &str, message_id: &str, summary: Option<&str>, reason: Option<&str>, ) -> Result<Value>

pub fn move_case(&self, case_ref: &str, group: &str) -> Result<Value>

pub fn archive_case( &self, case_ref: &str, reason: Option<&str>, ) -> Result<Value>

pub fn reopen_case(&self, case_ref: &str, reason: Option<&str>) -> Result<Value>

pub fn tag_case( &self, case_ref: &str, tag: &str, reason: Option<&str>, ) -> Result<Value>

pub fn untag_case( &self, case_ref: &str, tag: &str, reason: Option<&str>, ) -> Result<Value>

pub fn merge_case( &self, case_ref: &str, other_case_ref: &str, reason: Option<&str>, ) -> Result<Value>

pub fn rename_active_case( &self, case_ref: &str, name: &str, reason: Option<&str>, ) -> Result<Value>

pub fn active_case_show(&self, case_ref: &str) -> Result<Value>

pub fn case_list(&self) -> Result<Value>

pub fn active_case_notes_show(&self, case_ref: &str) -> Result<Value>

pub fn active_case_notes_append( &self, case_ref: &str, text: &str, ) -> Result<Value>

pub fn active_case_notes_replace( &self, case_ref: &str, text: &str, ) -> Result<Value>

pub fn archive_case_show(&self, case_ref: &str) -> Result<Value>

pub fn archive_case_restore( &self, case_ref: &str, group: &str, reason: Option<&str>, ) -> Result<Value>

pub fn archive_case_rename( &self, case_ref: &str, name: &str, reason: Option<&str>, ) -> Result<Value>

pub fn archive_case_notes_show(&self, case_ref: &str) -> Result<Value>

pub fn archive_case_notes_append( &self, case_ref: &str, text: &str, ) -> Result<Value>

pub fn archive_case_notes_replace( &self, case_ref: &str, text: &str, ) -> Result<Value>

pub fn find_case_required(&self, case_ref: &str) -> Result<PathBuf>

pub fn find_case(&self, case_ref: &str) -> Result<Option<PathBuf>>

impl Workspace

pub fn contact_create(&self, params: NewContact<'_>) -> Result<Value>

pub fn contact_list( &self, group: Option<&str>, tag: Option<&str>, org: Option<&str>, role: Option<&str>, ) -> Result<Value>

pub fn contact_show(&self, contact_ref: &str) -> Result<Value>

pub fn contact_move(&self, contact_ref: &str, new_group: &str) -> Result<Value>

pub fn contact_rename(&self, contact_ref: &str, new_name: &str) -> Result<Value>

pub fn contact_email_add(&self, contact_ref: &str, email: &str) -> Result<Value>

pub fn contact_email_remove( &self, contact_ref: &str, email: &str, ) -> Result<Value>

pub fn contact_phone_add(&self, contact_ref: &str, phone: &str) -> Result<Value>

pub fn contact_phone_remove( &self, contact_ref: &str, phone: &str, ) -> Result<Value>

pub fn contact_tag(&self, contact_ref: &str, tag: &str) -> Result<Value>

pub fn contact_untag(&self, contact_ref: &str, tag: &str) -> Result<Value>

pub fn contact_notes_show(&self, contact_ref: &str) -> Result<Value>

pub fn contact_notes_append( &self, contact_ref: &str, text: &str, ) -> Result<Value>

pub fn contact_notes_replace( &self, contact_ref: &str, text: &str, ) -> Result<Value>

pub fn contact_archive_contact( &self, contact_ref: &str, reason: Option<&str>, ) -> Result<Value>

pub fn contact_reopen_contact( &self, contact_ref: &str, group: Option<&str>, reason: Option<&str>, ) -> Result<Value>

pub fn contact_extract( &self, source: ContactExtractSource, group: Option<&str>, ) -> Result<Value>

impl Workspace

pub fn doctor(&self) -> Result<Value>

pub fn doctor_repair(&self, confirm: bool) -> Result<Value>

impl Workspace

pub fn show_draft(&self, case_ref: &str, draft_name: &str) -> Result<Value>

pub fn validate_draft(&self, case_ref: &str, draft_name: &str) -> Result<Value>

pub fn attach_file_to_draft( &self, case_ref: &str, draft_name: &str, source_path: &str, ) -> Result<Value>

pub fn remove_draft( &self, case_ref: &str, draft_name: &str, reason: Option<&str>, ) -> Result<Value>

pub fn save_draft(&self, case_ref: &str, draft_name: &str) -> Result<Value>

pub fn send_draft(&self, case_ref: &str, draft_name: &str) -> Result<Value>

pub fn reply_to_message( &self, case_ref: &str, message_id: &str, reply_all: bool, identity: Option<&str>, body: Option<&str>, body_file: Option<&str>, ) -> Result<Value>

pub fn fetch_message_attachment( &self, message_id: &str, part_id: Option<&str>, ) -> Result<Value>

impl Workspace

pub fn message_show(&self, message_id: &str) -> Result<Value>

pub fn spam_message( &self, message_id: &str, reason: Option<&str>, ) -> Result<Value>

pub fn restore_message( &self, message_id: &str, reason: Option<&str>, ) -> Result<Value>

pub fn archive_message( &self, message_id: &str, archive_ref: &str, summary: Option<&str>, reason: Option<&str>, ) -> Result<Value>

pub fn trash_message( &self, message_id: &str, reason: Option<&str>, ) -> Result<Value>

impl Workspace

pub fn purge_spam(&self, older_than_days: u64) -> Result<Value>

pub fn purge_trash(&self, older_than_days: u64) -> Result<Value>

pub fn purge_deleted(&self, older_than_days: u64) -> Result<Value>

pub fn purge_discards(&self, older_than_days: u64) -> Result<Value>

impl Workspace

pub fn pull(&self, ids: &[String]) -> Result<Value>

pub fn pull_with_progress( &self, ids: &[String], progress: Option<&mut (dyn FnMut(&str, Value) + '_)>, ) -> Result<Value>

impl Workspace

pub fn ensure_no_incomplete_transactions(&self) -> Result<()>

impl Workspace

pub fn triage_list(&self) -> Result<Value>

List untriaged messages by stable locator. Resolve details with path_templates or afmail message show.

pub fn refresh_triage_views(&self) -> Result<Value>

impl Workspace

pub fn at(path: impl Into<PathBuf>) -> Self

pub fn discover(start: impl AsRef<Path>) -> Result<Self>

pub fn root(&self) -> &Path

pub fn init_command(agent_root: &Path, path: Option<&str>) -> Result<Value>

pub fn init(&self) -> Result<Value>

pub fn status(&self) -> Result<Value>

pub fn config_show(&self) -> Result<Value>

pub fn config_get(&self, key: &str) -> Result<Value>

pub fn config_set(&self, key: &str, values: &[String]) -> Result<Value>

pub fn remote_test(&self) -> Result<Value>

pub fn remote_folders(&self) -> Result<Value>

pub fn push_with_progress( &self, confirmed: bool, progress: Option<&mut (dyn FnMut(&str, Value) + '_)>, ) -> Result<Value>

pub fn push_list(&self) -> Result<Value>

pub fn render_refresh(&self) -> Result<Value>

pub fn render_templates(&self, force: bool) -> Result<Value>

pub fn log_list(&self, limit: usize) -> Result<Value>

pub fn log_tail(&self) -> Result<Value>

pub fn log_message(&self, message_id: &str) -> Result<Value>

pub fn log_case(&self, case_ref: &str) -> Result<Value>

pub fn log_archive(&self, archive_ref: &str) -> Result<Value>

Trait Implementations

impl Clone for Workspace

fn clone(&self) -> Workspace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Workspace

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

Formats the value using the given formatter.