feat: Implement RFC 2342 (NAMESPACE) in imap-codec

[qbit-0]

(Edited by @duesee to include required syntax elements.)

---

Capability

IMAP4 servers that support this extension MUST list the keyword NAMESPACE in their CAPABILITY response.

Not defined formally, but should be ...

capability /= "NAMESPACE"

Command

The NAMESPACE command is valid in the Authenticated and Selected sate.

Namespace_Command = "NAMESPACE"

Response

Namespace_Response = "*" SP "NAMESPACE" SP Namespace SP Namespace SP Namespace
      ; The first Namespace is the Personal Namespace(s)
      ; The second Namespace is the Other Users' Namespace(s)
      ; The third Namespace is the Shared Namespace(s)

Namespace = nil /
            "("
              1*(
                "(" string SP  (<"> QUOTED_CHAR <"> / nil) *(Namespace_Response_Extension) ")"
              )
            ")"

Namespace_Response_Extension = SP string SP "(" string *(SP string) ")"

---

Updated by RFC 4466:

Capability

(...)

Command

Namespace-Command = "NAMESPACE"

Response

Namespace-Response = "NAMESPACE" SP Namespace SP Namespace SP Namespace
         ;; This response is currently only allowed
         ;; if the IMAP server supports [[NAMESPACE](https://www.rfc-editor.org/rfc/rfc4466#ref-NAMESPACE)].
         ;; The first Namespace is the Personal Namespace(s)
         ;; The second Namespace is the Other Users' Namespace(s)
         ;; The third Namespace is the Shared Namespace(s)

Namespace = nil / "(" 1*Namespace-Descr ")"

Namespace-Descr = "(" string SP (DQUOTE QUOTED-CHAR DQUOTE / nil) *(Namespace-Response-Extension) ")"

Namespace-Response-Extension = SP string SP "(" string *(SP string) ")"

[duesee]

Thanks for opening the issue here (as discussed via email).

I'll copy&paste from the thread:

Steps to contribute an extension:

• define a feature ext_namespace in imap-types and implement the required types.

• define a feature ext_namespace in imap-codec, make it use imap-types/ext_namespace, and implement the parsers and serializers.

• define a feature ext_namespace in imap-next, make it use imap-codec/ext_namespace, and proceed with your app :-)

I can mentor you through the process!

[qbit-0]

Is this correct so far? Right now it'll just encode the data with a placeholder "* NAMESPACE (("" "/")) (("#shared/" "/")) NIL"

qbit-0@88aaa89
qbit-0/imap-next@c2a691f

I tested it and this is what I see:

$ curl -v "imap://test:asdf@localhost:144/" -X 'NAMESPACE'
*   Trying 127.0.0.1:144...
* Connected to localhost (127.0.0.1) port 144 (#0)
< * OK [CAPABILITY IMAP4REV1 AUTH=PLAIN AUTH=LOGIN AUTH=CRAM-MD5 IDLE UIDPLUS NAMESPACE STARTTLS] IMAP server ready
> A001 CAPABILITY
< * CAPABILITY IMAP4REV1 AUTH=PLAIN AUTH=LOGIN AUTH=CRAM-MD5 IDLE UIDPLUS NAMESPACE STARTTLS
< A001 OK Capability response sent successfully
> A002 AUTHENTICATE CRAM-MD5
< + PGJuaVNZVWFiVjJsQzQwbUouMTc1ODU3ODg5N0Bsb2NhbGhvc3Q+
> dGVzdCBmNjY4M2NiOTg5ODI2ZDhmMjUyNjE5NzRjYTEyYjVlNg==
< A002 OK Authentication successful
> A003 NAMESPACE
< * NAMESPACE (("" "/")) (("#shared/" "/")) NIL
* NAMESPACE (("" "/")) (("#shared/" "/")) NIL
< A003 OK NAMESPACE completed
* Connection #0 to host localhost left intact

[duesee]

Looks great so far! :-)

[duesee]

You can also directly add the ext_namespace to the...

• justfile

  imap-codec/justfile

  Line 60 in 450fdf5

  ext_metadata \

  , and below

• imap-types-fuzz
  

  imap-codec/imap-types/fuzz/Cargo.toml

  Line 22 in 450fdf5

  ext_metadata = ["imap-types/ext_metadata"]

• imap-codec-fuzz
  

  imap-codec/imap-codec/fuzz/Cargo.toml

  Line 26 in 450fdf5

  ext_metadata = ["imap-codec/ext_metadata"]

I think these are all places. Don't worry if the CI will error out. When we are a bit further in the process, we'll get this all sorted out :-)

[qbit-0]

Added here:
qbit-0@be517f3

[qbit-0]

I'm not sure if I have the encoding right, but it looks correct with curl.

duyph@home-desktop MINGW64 ~/Documents/GitHub/rockliffe/mailsite-server/Source/HTTPMA (dev)
$ curl -v "imap://test:asdf@localhost:144/INBOX" -X 'NAMESPACE'
*   Trying 127.0.0.1:144...
* Connected to localhost (127.0.0.1) port 144 (#0)
< * OK [CAPABILITY IMAP4REV1 AUTH=PLAIN AUTH=LOGIN AUTH=CRAM-MD5 IDLE UIDPLUS NAMESPACE STARTTLS] IMAP server ready
> A001 CAPABILITY
< * CAPABILITY IMAP4REV1 AUTH=PLAIN AUTH=LOGIN AUTH=CRAM-MD5 IDLE UIDPLUS NAMESPACE STARTTLS
< A001 OK Capability response sent successfully
> A002 AUTHENTICATE CRAM-MD5
< + PFpZVjBhSGV6TDFDSmJhZkEuMTc1ODY3MjcyNUBsb2NhbGhvc3Q+
> dGVzdCBmNzZkNjM0YjYwZTlmNzU5ODhiNmMxZjIzYTI0Njk3Zg==
< A002 OK Authentication successful
> A003 SELECT INBOX
< * FLAGS (\Answered \Flagged \Deleted \Seen \Draft)
< * 9 EXISTS
< * 0 RECENT
< * OK [PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft)] Flags exist
< * OK [UIDVALIDITY 1758665365] UIDs valid
< * OK [UIDNEXT 1148328339] Predicted next UID
< A003 OK [READ-WRITE] Folder 'INBOX' selected
> A004 NAMESPACE
< * NAMESPACE (("" "/")) NIL (("#shared/" "/"))
* NAMESPACE (("" "/")) NIL (("#shared/" "/"))
< A004 OK NAMESPACE completed
* Connection #0 to host localhost left intact

    let personal_prefix = AString::from(Quoted::try_from("").unwrap());
    let personal_delimiter = QuotedChar::try_from('/').unwrap();
    let personal_namespace_list = Some(vec![NamespaceDescription::new(
        personal_prefix,
        Some(personal_delimiter),
    )]);

    let other_namespace_list = None;

    let shared_prefix = AString::from(Quoted::try_from("#shared/").unwrap());
    let shared_delimiter = QuotedChar::try_from('/').unwrap();
    let shared_namespace_list = Some(vec![NamespaceDescription::new(
        shared_prefix,
        Some(shared_delimiter),
    )]);

    let namespace_data = Data::namespace(
        personal_namespace_list,
        other_namespace_list,
        shared_namespace_list,
    )?;

    server.enqueue_data(namespace_data);

[duesee]

Hey! I'm on vacation for a few days, so will be a bit slower to respond. In the meantime... could you open a (draft) pull request against imap-codec? This would make it a bit easier for me to see the changes on a first glance :-)

[qbit-0]

#669