Add support for googles x-gm-labels extension (#138)

Author: estriv

imap-proto/src/builders/command.rs

@@ -253,6 +253,7 @@ fn push_attr(cmd: &mut Vec<u8>, attr: Attribute) {
             Attribute::Rfc822Size => "RFC822.SIZE",
             Attribute::Rfc822Text => "RFC822.TEXT",
             Attribute::Uid => "UID",
+            Attribute::GmailLabels => "X-GM-LABELS",
         }
         .as_bytes(),
     );

imap-proto/src/parser/gmail.rs

@@ -0,0 +1,52 @@
+use std::borrow::Cow;
+
+use nom::branch::alt;
+use nom::bytes::streaming::tag_no_case;
+use nom::combinator::map;
+use nom::sequence::preceded;
+use nom::IResult;
+
+use crate::{AttributeValue, MailboxDatum};
+
+use super::core::{parenthesized_list, quoted_utf8};
+use super::rfc3501::flag;
+
+pub(crate) fn gmail_label_list(i: &[u8]) -> IResult<&[u8], Vec<Cow<str>>> {
+    preceded(
+        tag_no_case("X-GM-LABELS "),
+        parenthesized_list(map(alt((flag, quoted_utf8)), Cow::Borrowed)),
+    )(i)
+}
+
+pub(crate) fn msg_att_gmail_labels(i: &[u8]) -> IResult<&[u8], AttributeValue> {
+    map(gmail_label_list, AttributeValue::GmailLabels)(i)
+}
+
+pub(crate) fn mailbox_data_gmail_labels(i: &[u8]) -> IResult<&[u8], MailboxDatum> {
+    map(gmail_label_list, MailboxDatum::GmailLabels)(i)
+}
+
+#[cfg(test)]
+mod tests {
+    use crate::types::*;
+    #[test]
+    fn test_gmail_labels() {
+        let env = br#"X-GM-LABELS (\Inbox \Sent Important "Muy Importante") "#;
+        match super::msg_att_gmail_labels(env) {
+            Ok((_, AttributeValue::GmailLabels(labels))) => {
+                println!("{:?}", labels);
+                assert_eq!(
+                    ["\\Inbox", "\\Sent", "Important", "Muy Importante"].to_vec(),
+                    labels
+                );
+            }
+            rsp => {
+                let e = rsp.unwrap_err();
+                if let nom::Err::Error(i) = &e {
+                    println!("{:?}", std::str::from_utf8(i.input));
+                }
+                panic!("unexpected response {:?}", e);
+            }
+        }
+    }
+}

imap-proto/src/parser/mod.rs

@@ -4,6 +4,7 @@ use nom::{branch::alt, IResult};
 pub mod core;
 
 pub mod bodystructure;
+pub mod gmail;
 pub mod rfc2087;
 pub mod rfc3501;
 pub mod rfc4315;

imap-proto/src/parser/rfc3501/mod.rs

@@ -25,6 +25,8 @@ use crate::{
     types::*,
 };
 
+use super::gmail;
+
 pub mod body;
 pub mod body_structure;
 
@@ -69,7 +71,7 @@ fn flag_extension(i: &[u8]) -> IResult<&[u8], &str> {
     )(i)
 }
 
-fn flag(i: &[u8]) -> IResult<&[u8], &str> {
+pub(crate) fn flag(i: &[u8]) -> IResult<&[u8], &str> {
     alt((flag_extension, atom))(i)
 }
 
@@ -361,6 +363,7 @@ fn mailbox_data(i: &[u8]) -> IResult<&[u8], MailboxDatum> {
         mailbox_data_status,
         mailbox_data_recent,
         mailbox_data_search,
+        gmail::mailbox_data_gmail_labels,
         rfc5256::mailbox_data_sort,
     ))(i)
 }
@@ -555,6 +558,7 @@ fn msg_att(i: &[u8]) -> IResult<&[u8], AttributeValue> {
         msg_att_rfc822_size,
         msg_att_rfc822_text,
         msg_att_uid,
+        gmail::msg_att_gmail_labels,
     ))(i)
 }
 

imap-proto/src/types.rs

@@ -220,6 +220,7 @@ pub enum MailboxDatum<'a> {
         mailbox: Cow<'a, str>,
         values: Vec<Cow<'a, str>>,
     },
+    GmailLabels(Vec<Cow<'a, str>>),
 }
 
 impl<'a> MailboxDatum<'a> {
@@ -260,6 +261,9 @@ impl<'a> MailboxDatum<'a> {
                     values: values.into_iter().map(to_owned_cow).collect(),
                 }
             }
+            MailboxDatum::GmailLabels(labels) => {
+                MailboxDatum::GmailLabels(labels.into_iter().map(to_owned_cow).collect())
+            }
         }
     }
 }
@@ -293,6 +297,8 @@ pub enum Attribute {
     Rfc822Size,
     Rfc822Text,
     Uid,
+    /// https://developers.google.com/gmail/imap/imap-extensions#access_to_gmail_labels_x-gm-labels
+    GmailLabels,
 }
 
 #[derive(Debug, Eq, PartialEq)]
@@ -327,6 +333,8 @@ pub enum AttributeValue<'a> {
     Rfc822Size(u32),
     Rfc822Text(Option<Cow<'a, [u8]>>),
     Uid(u32),
+    /// https://developers.google.com/gmail/imap/imap-extensions#access_to_gmail_labels_x-gm-labels
+    GmailLabels(Vec<Cow<'a, str>>),
 }
 
 impl<'a> AttributeValue<'a> {
@@ -353,6 +361,9 @@ impl<'a> AttributeValue<'a> {
             AttributeValue::Rfc822Size(v) => AttributeValue::Rfc822Size(v),
             AttributeValue::Rfc822Text(v) => AttributeValue::Rfc822Text(v.map(to_owned_cow)),
             AttributeValue::Uid(v) => AttributeValue::Uid(v),
+            AttributeValue::GmailLabels(v) => {
+                AttributeValue::GmailLabels(v.into_iter().map(to_owned_cow).collect())
+            }
         }
     }
 }