fix: add missing imap id config

Author: soywod

Cargo.toml

@@ -17,7 +17,7 @@ all-features = true
 rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
-default = ["imap", "jmap", "maildir", "rustls-ring"]
+default = ["rustls-ring", "imap", "jmap", "maildir"]
 imap = ["dep:io-imap", "io-email/imap", "io-imap/client", "pimalaya-cli/imap"]
 jmap = ["dep:base64", "dep:io-jmap", "io-email/jmap", "io-jmap/client", "pimalaya-cli/jmap"]
 maildir = ["dep:io-maildir", "io-email/maildir", "io-maildir/client"]

config.sample.toml

@@ -98,6 +98,17 @@ imap.sasl.plain.password.raw = "REPLACE_ME"
 #imap.sasl.scram-sha-256.username = "user@example.org"
 #imap.sasl.scram-sha-256.password.raw = "***"
 
+# RFC 2971 ID extension. Some providers (mail.qq.com, fastmail) require an `ID`
+# exchange straight after authentication; set `auto = true` to opt in.
+# https://www.rfc-editor.org/rfc/rfc2971.html
+#imap.id.auto = false
+
+# Per-field policy for the auto-ID command. Keys not listed here are NOT sent.
+# `true` substitutes mirador's canned value for the well-known keys (name,
+# version, vendor, support-url); unknown keys with `true` fall back to NIL with
+# a warning. `false` always sends NIL. An empty map sends `ID NIL`.
+#imap.id.fields = { name = true, version = true, vendor = true, support-url = true }
+
 # ---- JMAP backend (RFC 8620 §7.2 EventSource push) -----------------------------
 
 # JMAP server address. Either a bare authority (auto-discovered via

src/check.rs

@@ -105,6 +105,8 @@ fn check_imap(
     use io_imap::client::ImapClientStd;
     use pimalaya_stream::{sasl::Sasl, tls::Tls};
 
+    use crate::config::resolve_auto_id_params;
+
     let result = (|| -> Result<()> {
         let mut tls: Tls = imap_config.tls.clone().into();
         tls.rustls.alpn = vec!["imap".into()];
@@ -118,7 +120,8 @@ fn check_imap(
                 Some(cfg.try_into_sasl(host, port))
             })
             .transpose()?;
-        let _ = ImapClientStd::connect(&server, &tls, imap_config.starttls, sasl)?;
+        let auto_id = resolve_auto_id_params(&imap_config.id)?;
+        let _ = ImapClientStd::connect(&server, &tls, imap_config.starttls, sasl, auto_id)?;
         Ok(())
     })();
 

src/client.rs

@@ -85,6 +85,8 @@ pub fn open(account: AccountConfig, backend: Backend) -> Result<EmailClientStd>
 
 #[cfg(feature = "imap")]
 fn open_imap(config: crate::config::ImapConfig) -> Result<EmailClientStd> {
+    use crate::config::resolve_auto_id_params;
+
     let mut tls: Tls = config.tls.into();
     tls.rustls.alpn = vec!["imap".into()];
     let server = parse_imap_server(&config.server)?;
@@ -96,8 +98,10 @@ fn open_imap(config: crate::config::ImapConfig) -> Result<EmailClientStd> {
             Some(cfg.try_into_sasl(host, port))
         })
         .transpose()?;
+    let auto_id = resolve_auto_id_params(&config.id)?;
 
-    let mut client = EmailClientStd::new().connect_imap(&server, &tls, config.starttls, sasl)?;
+    let mut client =
+        EmailClientStd::new().connect_imap(&server, &tls, config.starttls, sasl, auto_id)?;
     if let Some(imap) = client.imap.as_mut() {
         // NOTE: mirador owns the connection for the lifetime of the
         // watch (IDLE + QRESYNC); auto_select would just cause an

src/config.rs

@@ -35,6 +35,13 @@ use std::{
 };
 
 use anyhow::Result;
+#[cfg(feature = "imap")]
+use anyhow::anyhow;
+#[cfg(feature = "imap")]
+use io_imap::types::{
+    IntoStatic,
+    core::{IString, NString},
+};
 use pimalaya_config::command;
 #[cfg(feature = "imap")]
 use pimalaya_config::secret::Secret;
@@ -145,6 +152,85 @@ pub struct ImapConfig {
     /// Optional SASL credentials. When omitted, the connection skips
     /// authentication entirely (no `AUTHENTICATE` is sent).
     pub sasl: Option<SaslConfig>,
+
+    /// RFC 2971 `ID` extension quirks. Some providers (notably
+    /// mail.qq.com, fastmail) require an `ID` exchange straight after
+    /// authentication; set `id.auto = true` to opt in.
+    #[serde(default)]
+    pub id: ImapIdConfig,
+}
+
+/// Per-account `imap.id.*` quirks.
+#[derive(Clone, Debug, Default, Deserialize, Serialize)]
+#[serde(rename_all = "kebab-case", deny_unknown_fields)]
+pub struct ImapIdConfig {
+    /// When `true`, the auth coroutine chains an `ID` round-trip
+    /// after the tagged auth response. Default `false` skips ID
+    /// entirely.
+    #[serde(default)]
+    pub auto: bool,
+
+    /// Parameters sent with the auto-ID command. Empty (default)
+    /// sends `ID NIL`. For each entry: `true` substitutes mirador's
+    /// canned value for the well-known keys (`name`, `version`,
+    /// `vendor`, `support-url`) or `NIL` for unknown keys; `false`
+    /// always sends `NIL`. Keys absent from this map are not
+    /// transmitted.
+    #[serde(default)]
+    pub fields: HashMap<String, bool>,
+}
+
+/// Resolves an [`ImapIdConfig`] into the wire-level parameter list
+/// passed to the io-imap auth coroutines.
+///
+/// [`None`] when `auto = false`; otherwise a vec where each entry
+/// maps the user-supplied key to either mirador's canned value
+/// (when the user set `true` and the key is well-known) or `NIL`.
+/// Unknown keys with `true` log a warning and fall back to `NIL`.
+#[cfg(feature = "imap")]
+pub fn resolve_auto_id_params(
+    config: &ImapIdConfig,
+) -> Result<Option<Vec<(IString<'static>, NString<'static>)>>> {
+    if !config.auto {
+        return Ok(None);
+    }
+
+    let mut params = Vec::with_capacity(config.fields.len());
+    for (key, &use_canned) in &config.fields {
+        let ikey = IString::try_from(key.clone())
+            .map_err(|err| anyhow!("Invalid IMAP ID parameter key `{key}`: {err}"))?
+            .into_static();
+
+        let nval = if use_canned {
+            match canned_imap_id_value(key) {
+                Some(value) => NString::try_from(value)
+                    .map_err(|err| {
+                        anyhow!("Invalid canned IMAP ID value `{value}` for `{key}`: {err}")
+                    })?
+                    .into_static(),
+                None => {
+                    log::warn!("imap.id.fields.{key} = true: no canned value defined, sending NIL");
+                    NString::NIL
+                }
+            }
+        } else {
+            NString::NIL
+        };
+
+        params.push((ikey, nval));
+    }
+    Ok(Some(params))
+}
+
+#[cfg(feature = "imap")]
+fn canned_imap_id_value(key: &str) -> Option<&'static str> {
+    match key {
+        "name" => Some(env!("CARGO_PKG_NAME")),
+        "version" => Some(env!("CARGO_PKG_VERSION")),
+        "vendor" => Some("Pimalaya"),
+        "support-url" => Some("https://github.com/pimalaya/mirador"),
+        _ => None,
+    }
 }
 
 // ---- JMAP ---------------------------------------------------------