Add RFC 5464 response codes (#116)

Author: jonhoo

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

@@ -176,6 +176,10 @@ fn resp_text_code(i: &[u8]) -> IResult<&[u8], ResponseCode> {
             rfc4315::resp_text_code_append_uid,
             rfc4315::resp_text_code_copy_uid,
             rfc4315::resp_text_code_uid_not_sticky,
+            rfc5464::resp_text_code_metadata_long_entries,
+            rfc5464::resp_text_code_metadata_max_size,
+            rfc5464::resp_text_code_metadata_too_many,
+            rfc5464::resp_text_code_metadata_no_private,
         )),
         tag(b"]"),
     )(i)

imap-proto/src/parser/rfc5464.rs

@@ -179,6 +179,42 @@ pub(crate) fn metadata_unsolicited(i: &[u8]) -> IResult<&[u8], Response> {
     ))
 }
 
+// There are any entries with values larger than the MAXSIZE limit given to GETMETADATA.
+// Extends resp-test-code defined in rfc3501.
+// [RFC5464 - 4.2.1 MAXSIZE GETMETADATA Command Option](https://tools.ietf.org/html/rfc5464#section-4.2.1)
+// [RFC5464 - 5. Formal Syntax - resp-text-code](https://tools.ietf.org/html/rfc5464#section-5)
+pub(crate) fn resp_text_code_metadata_long_entries(i: &[u8]) -> IResult<&[u8], ResponseCode> {
+    let (i, (_, num)) = tuple((tag_no_case("METADATA LONGENTRIES "), number_64))(i)?;
+    Ok((i, ResponseCode::MetadataLongEntries(num)))
+}
+
+// Server is unable to set an annotation because the size of its value is too large.
+// Extends resp-test-code defined in rfc3501.
+// [RFC5464 - 4.3 SETMETADATA Command](https://tools.ietf.org/html/rfc5464#section-4.3)
+// [RFC5464 - 5. Formal Syntax - resp-text-code](https://tools.ietf.org/html/rfc5464#section-5)
+pub(crate) fn resp_text_code_metadata_max_size(i: &[u8]) -> IResult<&[u8], ResponseCode> {
+    let (i, (_, num)) = tuple((tag_no_case("METADATA MAXSIZE "), number_64))(i)?;
+    Ok((i, ResponseCode::MetadataMaxSize(num)))
+}
+
+// Server is unable to set a new annotation because the maximum number of allowed annotations has already been reached.
+// Extends resp-test-code defined in rfc3501.
+// [RFC5464 - 4.3 SETMETADATA Command](https://tools.ietf.org/html/rfc5464#section-4.3)
+// [RFC5464 - 5. Formal Syntax - resp-text-code](https://tools.ietf.org/html/rfc5464#section-5)
+pub(crate) fn resp_text_code_metadata_too_many(i: &[u8]) -> IResult<&[u8], ResponseCode> {
+    let (i, _) = tag_no_case("METADATA TOOMANY")(i)?;
+    Ok((i, ResponseCode::MetadataTooMany))
+}
+
+// Server is unable to set a new annotation because it does not support private annotations on one of the specified mailboxes.
+// Extends resp-test-code defined in rfc3501.
+// [RFC5464 - 4.3 SETMETADATA Command](https://tools.ietf.org/html/rfc5464#section-4.3)
+// [RFC5464 - 5. Formal Syntax - resp-text-code](https://tools.ietf.org/html/rfc5464#section-5)
+pub(crate) fn resp_text_code_metadata_no_private(i: &[u8]) -> IResult<&[u8], ResponseCode> {
+    let (i, _) = tag_no_case("METADATA NOPRIVATE")(i)?;
+    Ok((i, ResponseCode::MetadataNoPrivate))
+}
+
 #[cfg(test)]
 mod tests {
     use super::{metadata_solicited, metadata_unsolicited};
@@ -292,4 +328,57 @@ mod tests {
             _ => panic!("Correct METADATA response is not parsed properly."),
         }
     }
+
+    #[test]
+    fn test_response_codes() {
+        use crate::parser::parse_response;
+
+        match parse_response(b"* OK [METADATA LONGENTRIES 123] Some entries omitted.\r\n") {
+            Ok((
+                _,
+                Response::Data {
+                    status: Status::Ok,
+                    code: Some(ResponseCode::MetadataLongEntries(123)),
+                    information: Some("Some entries omitted."),
+                },
+            )) => {}
+            rsp => panic!("unexpected response {:?}", rsp),
+        }
+
+        match parse_response(b"* NO [METADATA MAXSIZE 123] Annotation too large.\r\n") {
+            Ok((
+                _,
+                Response::Data {
+                    status: Status::No,
+                    code: Some(ResponseCode::MetadataMaxSize(123)),
+                    information: Some("Annotation too large."),
+                },
+            )) => {}
+            rsp => panic!("unexpected response {:?}", rsp),
+        }
+
+        match parse_response(b"* NO [METADATA TOOMANY] Too many annotations.\r\n") {
+            Ok((
+                _,
+                Response::Data {
+                    status: Status::No,
+                    code: Some(ResponseCode::MetadataTooMany),
+                    information: Some("Too many annotations."),
+                },
+            )) => {}
+            rsp => panic!("unexpected response {:?}", rsp),
+        }
+
+        match parse_response(b"* NO [METADATA NOPRIVATE] Private annotations not supported.\r\n") {
+            Ok((
+                _,
+                Response::Data {
+                    status: Status::No,
+                    code: Some(ResponseCode::MetadataNoPrivate),
+                    information: Some("Private annotations not supported."),
+                },
+            )) => {}
+            rsp => panic!("unexpected response {:?}", rsp),
+        }
+    }
 }

imap-proto/src/types.rs

@@ -71,6 +71,10 @@ pub enum ResponseCode<'a> {
     AppendUid(u32, Vec<UidSetMember>),
     CopyUid(u32, Vec<UidSetMember>, Vec<UidSetMember>),
     UidNotSticky,
+    MetadataLongEntries(u64), // RFC 5464, section 4.2.1
+    MetadataMaxSize(u64),     // RFC 5464, section 4.3
+    MetadataTooMany,          // RFC 5464, section 4.3
+    MetadataNoPrivate,        // RFC 5464, section 4.3
 }
 #[derive(Clone, Debug, Eq, PartialEq)]
 pub enum UidSetMember {