From 5dc51ac6b19923c189d78ad984b77fbb27d581cb Mon Sep 17 00:00:00 2001 From: Jon Gjengset Date: Thu, 22 Nov 2018 17:57:56 -0500 Subject: [PATCH] Show example of how to use store to delete --- src/client.rs | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/client.rs b/src/client.rs index 598ac8f..67878ae 100644 --- a/src/client.rs +++ b/src/client.rs @@ -722,6 +722,21 @@ impl Session { /// - `-FLAGS.SILENT `: Equivalent to `-FLAGS`, but without returning a new value. /// /// In all cases, `` is a space-separated list enclosed in parentheses. + /// + /// # Examples + /// + /// Delete a message: + /// + /// ```rust,no_run + /// # extern crate imap; + /// # use imap::{self, Session}; + /// # use std::net::TcpStream; + /// fn delete(seq: imap::types::Seq, s: &mut Session) -> imap::error::Result<()> { + /// s.store(format!("{}", seq), "+FLAGS (\\Deleted)")?; + /// s.expunge()?; + /// Ok(()) + /// } + /// ``` pub fn store(&mut self, sequence_set: S1, query: S2) -> ZeroCopyResult> where S1: AsRef,