client: Add SEARCH and UID SEARCH support

src/client.rs

@@ -9,7 +9,7 @@ use std::ops::{Deref,DerefMut};
 use super::authenticator::Authenticator;
 use super::error::{Error, ParseError, Result, ValidateError};
 use super::parse::{
-    parse_authenticate_response, parse_capabilities, parse_fetches, parse_mailbox, parse_names,
+    parse_authenticate_response, parse_capabilities, parse_fetches, parse_mailbox, parse_names, parse_search_ids,
 };
 use super::types::*;
 
@@ -620,6 +620,21 @@ impl <T: Read + Write> Session<T> {
         self.read_response().map(|_| ())
     }
 
+    /// Searches the mailbox for messages that match the given criteria and returns
+    /// the list of message sequence numbers of those messages.
+    pub fn search(&mut self, query: &str) -> Result<Vec<u32>> {
+        self.run_command_and_read_response(&format!("SEARCH {}", query))
+            .and_then(|lines| parse_search_ids(&lines[..]))
+    }
+
+    /// Searches the mailbox for messages that match the given criteria and returns
+    /// the list of unique identifier numbers of those messages.
+    pub fn uid_search(&mut self, query: &str) -> Result<Vec<u32>> {
+        eprint!("{}", format!("UID SEARCH {}", query));
+        self.run_command_and_read_response(&format!("UID SEARCH {}", query))
+            .and_then(|lines| parse_search_ids(&lines[..]))
+    }
+
     // these are only here because they are public interface, the rest is in `Connection`
     /// Runs a command and checks if it returns OK.
     pub fn run_command_and_check_ok(&mut self, command: &str) -> Result<()> {
@@ -1056,6 +1071,36 @@ mod tests {
         assert_eq!(mailbox, expected_mailbox);
     }
 
+    #[test]
+    fn search() {
+        let response = b"* SEARCH 1 2 3 4 5\r\n\
+            a1 OK Search completed\r\n"
+            .to_vec();
+        let mock_stream = MockStream::new(response);
+        let mut session = mock_session!(mock_stream);
+        let ids = session.search("Unseen").unwrap();
+        assert!(
+            session.stream.get_ref().written_buf == b"a1 SEARCH Unseen\r\n".to_vec(),
+            "Invalid search command"
+        );
+        assert_eq!(ids, vec![1, 2, 3, 4, 5]);
+    }
+
+    #[test]
+    fn uid_search() {
+        let response = b"* SEARCH 1 2 3 4 5\r\n\
+            a1 OK Search completed\r\n"
+            .to_vec();
+        let mock_stream = MockStream::new(response);
+        let mut session = mock_session!(mock_stream);
+        let ids = session.uid_search("Unseen").unwrap();
+        assert!(
+            session.stream.get_ref().written_buf == b"a1 UID SEARCH Unseen\r\n".to_vec(),
+            "Invalid search command"
+        );
+        assert_eq!(ids, vec![1, 2, 3, 4, 5]);
+    }
+
     #[test]
     fn capability() {
         let response = b"* CAPABILITY IMAP4rev1 STARTTLS AUTH=GSSAPI LOGINDISABLED\r\n\

src/parse.rs

@@ -1,6 +1,7 @@
 use imap_proto::{self, MailboxDatum, Response};
 use nom::IResult;
 use regex::Regex;
+use std::str;
 
 use super::error::{Error, ParseError, Result};
 use super::types::*;
@@ -222,6 +223,26 @@ pub fn parse_mailbox(mut lines: &[u8]) -> Result<Mailbox> {
     }
 }
 
+pub fn parse_search_ids(lines: &[u8]) -> Result<Vec<u32>> {
+    match str::from_utf8(lines) {
+        Ok(resp) => {
+            let re = Regex::new(r"^(?i)\* SEARCH((?:\s+[0-9]+)*)\s*$").unwrap();
+            match re.captures(resp) {
+                Some(cap) => {
+                    let mut line = cap.get(1).map(|m| m.as_str()).unwrap_or("");
+                    Ok(line
+                        .trim()
+                        .split(' ')
+                        .filter_map(|id| id.trim().parse().ok())
+                        .collect())
+                }
+                None => Err(Error::Parse(ParseError::Invalid(lines.to_vec()))),
+            }
+        }
+        Err(_) => Err(Error::Parse(ParseError::Invalid(lines.to_vec()))),
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -289,4 +310,26 @@ mod tests {
         assert_eq!(fetches[0].message, 37);
         assert_eq!(fetches[0].uid, Some(74));
     }
+
+    #[test]
+    fn parse_search_ids_test() {
+        let lines = "* SEARCH 1600 1698 1739 1781 1795 1885 1891 1892 1893 1898 1899 1901 1911 1926 1932 1933 1993 1994 2007 2032 2033 2041 2053 2062 2063 2065 2066 2072 2078 2079 2082 2084 2095 2100 2101 2102 2103 2104 2107 2116 2120 2135 2138 2154 2163 2168 2172 2189 2193 2198 2199 2205 2212 2213 2221 2227 2267 2275 2276 2295 2300 2328 2330 2332 2333 2334 2335 2336 2337 2338 2339 2341 2342 2347 2349 2350 2358 2359 2362 2369 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2390 2392 2397 2400 2401 2403 2405 2409 2411 2414 2417 2419 2420 2424 2426 2428 2439 2454 2456 2467 2468 2469 2490 2515 2519 2520 2521".as_bytes();
+        assert_eq!(
+            parse_search_ids(lines).unwrap(),
+            vec![
+                1600, 1698, 1739, 1781, 1795, 1885, 1891, 1892, 1893, 1898, 1899, 1901, 1911, 1926,
+                1932, 1933, 1993, 1994, 2007, 2032, 2033, 2041, 2053, 2062, 2063, 2065, 2066, 2072,
+                2078, 2079, 2082, 2084, 2095, 2100, 2101, 2102, 2103, 2104, 2107, 2116, 2120, 2135,
+                2138, 2154, 2163, 2168, 2172, 2189, 2193, 2198, 2199, 2205, 2212, 2213, 2221, 2227,
+                2267, 2275, 2276, 2295, 2300, 2328, 2330, 2332, 2333, 2334, 2335, 2336, 2337, 2338,
+                2339, 2341, 2342, 2347, 2349, 2350, 2358, 2359, 2362, 2369, 2371, 2372, 2373, 2374,
+                2375, 2376, 2377, 2378, 2379, 2380, 2381, 2382, 2383, 2384, 2385, 2386, 2390, 2392,
+                2397, 2400, 2401, 2403, 2405, 2409, 2411, 2414, 2417, 2419, 2420, 2424, 2426, 2428,
+                2439, 2454, 2456, 2467, 2468, 2469, 2490, 2515, 2519, 2520, 2521
+            ]
+        );
+
+        let lines = "* SEARCH".as_bytes();
+        assert_eq!(parse_search_ids(lines).unwrap(), Vec::<u32>::new());
+    }
 }