refactor message with clap derive api (part 1)

src/email/message/command/copy.rs

@@ -0,0 +1,52 @@
+use anyhow::Result;
+use clap::Parser;
+use log::info;
+
+use crate::{
+    account::arg::name::AccountNameFlag,
+    backend::Backend,
+    cache::arg::disable::DisableCacheFlag,
+    config::TomlConfig,
+    envelope::arg::ids::EnvelopeIdsArgs,
+    folder::arg::name::{SourceFolderNameArg, TargetFolderNameArg},
+    printer::Printer,
+};
+
+/// Copy a message from a source folder to a target folder
+#[derive(Debug, Parser)]
+pub struct MessageCopyCommand {
+    #[command(flatten)]
+    pub source_folder: SourceFolderNameArg,
+
+    #[command(flatten)]
+    pub target_folder: TargetFolderNameArg,
+
+    #[command(flatten)]
+    pub envelopes: EnvelopeIdsArgs,
+
+    #[command(flatten)]
+    pub cache: DisableCacheFlag,
+
+    #[command(flatten)]
+    pub account: AccountNameFlag,
+}
+
+impl MessageCopyCommand {
+    pub async fn execute(self, printer: &mut impl Printer, config: &TomlConfig) -> Result<()> {
+        info!("executing message copy command");
+
+        let from_folder = &self.source_folder.name;
+        let to_folder = &self.target_folder.name;
+        let account = self.account.name.as_ref().map(String::as_str);
+        let cache = self.cache.disable;
+
+        let (toml_account_config, account_config) =
+            config.clone().into_account_configs(account, cache)?;
+        let backend = Backend::new(toml_account_config, account_config.clone(), false).await?;
+
+        let ids = &self.envelopes.ids;
+        backend.copy_messages(from_folder, to_folder, ids).await?;
+
+        printer.print("Message(s) successfully copied from {from_folder} to {to_folder}!")
+    }
+}

src/email/message/command/delete.rs

@@ -0,0 +1,44 @@
+use anyhow::Result;
+use clap::Parser;
+use log::info;
+
+use crate::{
+    account::arg::name::AccountNameFlag, backend::Backend, cache::arg::disable::DisableCacheFlag,
+    config::TomlConfig, envelope::arg::ids::EnvelopeIdsArgs, folder::arg::name::FolderNameArg,
+    printer::Printer,
+};
+
+/// Delete a message from a folder
+#[derive(Debug, Parser)]
+pub struct MessageDeleteCommand {
+    #[command(flatten)]
+    pub folder: FolderNameArg,
+
+    #[command(flatten)]
+    pub envelopes: EnvelopeIdsArgs,
+
+    #[command(flatten)]
+    pub cache: DisableCacheFlag,
+
+    #[command(flatten)]
+    pub account: AccountNameFlag,
+}
+
+impl MessageDeleteCommand {
+    pub async fn execute(self, printer: &mut impl Printer, config: &TomlConfig) -> Result<()> {
+        info!("executing message delete command");
+
+        let folder = &self.folder.name;
+        let account = self.account.name.as_ref().map(String::as_str);
+        let cache = self.cache.disable;
+
+        let (toml_account_config, account_config) =
+            config.clone().into_account_configs(account, cache)?;
+        let backend = Backend::new(toml_account_config, account_config.clone(), false).await?;
+
+        let ids = &self.envelopes.ids;
+        backend.delete_messages(folder, ids).await?;
+
+        printer.print("Message(s) successfully deleted from {from_folder} to {to_folder}!")
+    }
+}

src/email/message/command/mod.rs

@@ -0,0 +1,58 @@
+pub mod copy;
+pub mod delete;
+pub mod move_;
+pub mod read;
+pub mod save;
+pub mod send;
+
+use anyhow::Result;
+use clap::Subcommand;
+
+use crate::{config::TomlConfig, printer::Printer};
+
+use self::{
+    copy::MessageCopyCommand, delete::MessageDeleteCommand, move_::MessageMoveCommand,
+    read::MessageReadCommand, save::MessageSaveCommand, send::MessageSendCommand,
+};
+
+/// Subcommand to manage messages
+#[derive(Debug, Subcommand)]
+pub enum MessageSubcommand {
+    /// Read a message
+    #[command(arg_required_else_help = true)]
+    Read(MessageReadCommand),
+
+    /// Save a message to a folder
+    #[command(arg_required_else_help = true)]
+    #[command(alias = "add", alias = "create")]
+    Save(MessageSaveCommand),
+
+    /// Send a message
+    #[command(arg_required_else_help = true)]
+    Send(MessageSendCommand),
+
+    /// Copy a message from a source folder to a target folder
+    #[command(arg_required_else_help = true)]
+    Copy(MessageCopyCommand),
+
+    /// Move a message from a source folder to a target folder
+    #[command(arg_required_else_help = true)]
+    Move(MessageMoveCommand),
+
+    /// Delete a message from a folder
+    #[command(arg_required_else_help = true)]
+    Delete(MessageDeleteCommand),
+}
+
+impl MessageSubcommand {
+    pub async fn execute(self, printer: &mut impl Printer, config: &TomlConfig) -> Result<()> {
+        match self {
+            Self::Read(cmd) => cmd.execute(printer, config).await,
+            Self::Save(cmd) => cmd.execute(printer, config).await,
+            Self::Send(cmd) => cmd.execute(printer, config).await,
+            Self::Copy(cmd) => cmd.execute(printer, config).await,
+            Self::Move(cmd) => cmd.execute(printer, config).await,
+            Self::Delete(cmd) => cmd.execute(printer, config).await,
+        }
+    }
+}

src/email/message/command/move_.rs

@@ -0,0 +1,52 @@
+use anyhow::Result;
+use clap::Parser;
+use log::info;
+
+use crate::{
+    account::arg::name::AccountNameFlag,
+    backend::Backend,
+    cache::arg::disable::DisableCacheFlag,
+    config::TomlConfig,
+    envelope::arg::ids::EnvelopeIdsArgs,
+    folder::arg::name::{SourceFolderNameArg, TargetFolderNameArg},
+    printer::Printer,
+};
+
+/// Move a message from a source folder to a target folder
+#[derive(Debug, Parser)]
+pub struct MessageMoveCommand {
+    #[command(flatten)]
+    pub source_folder: SourceFolderNameArg,
+
+    #[command(flatten)]
+    pub target_folder: TargetFolderNameArg,
+
+    #[command(flatten)]
+    pub envelopes: EnvelopeIdsArgs,
+
+    #[command(flatten)]
+    pub cache: DisableCacheFlag,
+
+    #[command(flatten)]
+    pub account: AccountNameFlag,
+}
+
+impl MessageMoveCommand {
+    pub async fn execute(self, printer: &mut impl Printer, config: &TomlConfig) -> Result<()> {
+        info!("executing message move command");
+
+        let from_folder = &self.source_folder.name;
+        let to_folder = &self.target_folder.name;
+        let account = self.account.name.as_ref().map(String::as_str);
+        let cache = self.cache.disable;
+
+        let (toml_account_config, account_config) =
+            config.clone().into_account_configs(account, cache)?;
+        let backend = Backend::new(toml_account_config, account_config.clone(), false).await?;
+
+        let ids = &self.envelopes.ids;
+        backend.move_messages(from_folder, to_folder, ids).await?;
+
+        printer.print("Message(s) successfully moved from {from_folder} to {to_folder}!")
+    }
+}

src/email/message/command/read.rs

@@ -0,0 +1,117 @@
+use anyhow::Result;
+use clap::Parser;
+use log::info;
+use mml::message::FilterParts;
+
+use crate::{
+    account::arg::name::AccountNameFlag, backend::Backend, cache::arg::disable::DisableCacheFlag,
+    config::TomlConfig, envelope::arg::ids::EnvelopeIdsArgs, folder::arg::name::FolderNameArg,
+    printer::Printer,
+};
+
+/// Read a message from a folder
+#[derive(Debug, Parser)]
+pub struct MessageReadCommand {
+    #[command(flatten)]
+    pub folder: FolderNameArg,
+
+    #[command(flatten)]
+    pub envelopes: EnvelopeIdsArgs,
+
+    /// Read the raw version of the message
+    ///
+    /// The raw message represents the message as it is on the
+    /// backend, unedited: not decoded nor decrypted. This is useful
+    /// for debugging faulty messages, but also for
+    /// saving/sending/transfering messages.
+    #[arg(long, short)]
+    #[arg(conflicts_with = "no_headers")]
+    #[arg(conflicts_with = "headers")]
+    pub raw: bool,
+
+    /// Read only body of text/html parts
+    ///
+    /// This argument is useful when you need to read the HTML version
+    /// of a message. Combined with --no-headers, you can write it to
+    /// a .html file and open it with your favourite browser.
+    #[arg(long)]
+    #[arg(conflicts_with = "raw")]
+    pub html: bool,
+
+    /// Read only the body of the message
+    ///
+    /// All headers will be removed from the message.
+    #[arg(long)]
+    #[arg(conflicts_with = "raw")]
+    #[arg(conflicts_with = "headers")]
+    pub no_headers: bool,
+
+    /// List of headers that should be visible at the top of the
+    /// message
+    ///
+    /// If a given header is not found in the message, it will not be
+    /// visible. If no header is given, defaults to the one set up in
+    /// your TOML configuration file.
+    #[arg(long = "header", short = 'H', value_name = "NAME")]
+    #[arg(conflicts_with = "raw")]
+    #[arg(conflicts_with = "no_headers")]
+    pub headers: Vec<String>,
+
+    #[command(flatten)]
+    pub cache: DisableCacheFlag,
+
+    #[command(flatten)]
+    pub account: AccountNameFlag,
+}
+
+impl MessageReadCommand {
+    pub async fn execute(self, printer: &mut impl Printer, config: &TomlConfig) -> Result<()> {
+        info!("executing message read command");
+
+        let folder = &self.folder.name;
+        let account = self.account.name.as_ref().map(String::as_str);
+        let cache = self.cache.disable;
+
+        let (toml_account_config, account_config) =
+            config.clone().into_account_configs(account, cache)?;
+        let backend = Backend::new(toml_account_config, account_config.clone(), false).await?;
+
+        let ids = &self.envelopes.ids;
+        let emails = backend.get_messages(&folder, &ids).await?;
+
+        let mut glue = "";
+        let mut bodies = String::default();
+
+        for email in emails.to_vec() {
+            bodies.push_str(glue);
+
+            if self.raw {
+                // emails do not always have valid utf8, uses "lossy" to
+                // display what can be displayed
+                bodies.push_str(&String::from_utf8_lossy(email.raw()?).into_owned());
+            } else {
+                let tpl: String = email
+                    .to_read_tpl(&account_config, |mut tpl| {
+                        if self.no_headers {
+                            tpl = tpl.with_hide_all_headers();
+                        } else if !self.headers.is_empty() {
+                            tpl = tpl.with_show_only_headers(&self.headers);
+                        }
+
+                        if self.html {
+                            tpl = tpl.with_filter_parts(FilterParts::Only("text/html".into()));
+                        }
+
+                        tpl
+                    })
+                    .await?
+                    .into();
+                bodies.push_str(&tpl);
+            }
+
+            glue = "\n\n";
+        }
+
+        printer.print(bodies)
+    }
+}

src/email/message/command/save.rs

@@ -0,0 +1,61 @@
+use anyhow::Result;
+use atty::Stream;
+use clap::Parser;
+use log::info;
+use std::io::{self, BufRead};
+
+use crate::{
+    account::arg::name::AccountNameFlag, backend::Backend, cache::arg::disable::DisableCacheFlag,
+    config::TomlConfig, folder::arg::name::FolderNameArg, printer::Printer,
+};
+
+/// Save a message to a folder
+#[derive(Debug, Parser)]
+pub struct MessageSaveCommand {
+    #[command(flatten)]
+    pub folder: FolderNameArg,
+
+    /// The raw message to save
+    #[arg(value_name = "MESSAGE", raw = true)]
+    pub raw: String,
+
+    #[command(flatten)]
+    pub cache: DisableCacheFlag,
+
+    #[command(flatten)]
+    pub account: AccountNameFlag,
+}
+
+impl MessageSaveCommand {
+    pub async fn execute(self, printer: &mut impl Printer, config: &TomlConfig) -> Result<()> {
+        info!("executing message save command");
+
+        let folder = &self.folder.name;
+        let account = self.account.name.as_ref().map(String::as_str);
+        let cache = self.cache.disable;
+        let raw_msg = &self.raw;
+
+        let (toml_account_config, account_config) =
+            config.clone().into_account_configs(account, cache)?;
+        let backend = Backend::new(toml_account_config, account_config.clone(), true).await?;
+
+        let is_tty = atty::is(Stream::Stdin);
+        let is_json = printer.is_json();
+        let raw_email = if is_tty || is_json {
+            raw_msg.replace("\r", "").replace("\n", "\r\n")
+        } else {
+            io::stdin()
+                .lock()
+                .lines()
+                .filter_map(Result::ok)
+                .collect::<Vec<String>>()
+                .join("\r\n")
+        };
+
+        backend
+            .add_raw_message(folder, raw_email.as_bytes())
+            .await?;
+
+        printer.print("Message successfully saved to {folder}!")
+    }
+}

src/email/message/command/send.rs

@@ -0,0 +1,65 @@
+use anyhow::Result;
+use atty::Stream;
+use clap::Parser;
+use email::flag::Flag;
+use log::info;
+use std::io::{self, BufRead};
+
+use crate::{
+    account::arg::name::AccountNameFlag, backend::Backend, cache::arg::disable::DisableCacheFlag,
+    config::TomlConfig, printer::Printer,
+};
+
+/// Send a message from a folder
+#[derive(Debug, Parser)]
+pub struct MessageSendCommand {
+    /// The raw message to send
+    #[arg(value_name = "MESSAGE", raw = true)]
+    pub raw: String,
+
+    #[command(flatten)]
+    pub cache: DisableCacheFlag,
+
+    #[command(flatten)]
+    pub account: AccountNameFlag,
+}
+
+impl MessageSendCommand {
+    pub async fn execute(self, printer: &mut impl Printer, config: &TomlConfig) -> Result<()> {
+        info!("executing message send command");
+
+        let account = self.account.name.as_ref().map(String::as_str);
+        let cache = self.cache.disable;
+        let raw_msg = &self.raw;
+
+        let (toml_account_config, account_config) =
+            config.clone().into_account_configs(account, cache)?;
+        let backend = Backend::new(toml_account_config, account_config.clone(), true).await?;
+        let folder = account_config.sent_folder_alias()?;
+
+        let is_tty = atty::is(Stream::Stdin);
+        let is_json = printer.is_json();
+        let raw_email = if is_tty || is_json {
+            raw_msg.replace("\r", "").replace("\n", "\r\n")
+        } else {
+            io::stdin()
+                .lock()
+                .lines()
+                .filter_map(Result::ok)
+                .collect::<Vec<String>>()
+                .join("\r\n")
+        };
+
+        backend.send_raw_message(raw_email.as_bytes()).await?;
+
+        if account_config.email_sending_save_copy.unwrap_or_default() {
+            backend
+                .add_raw_message_with_flag(&folder, raw_email.as_bytes(), Flag::Seen)
+                .await?;
+
+            printer.print("Message successfully sent and saved to {folder}!")
+        } else {
+            printer.print("Message successfully sent!")
+        }
+    }
+}

src/email/message/handlers.rs

@@ -69,29 +69,6 @@ pub async fn attachments<P: Printer>(
     }
 }
 
-pub async fn copy<P: Printer>(
-    printer: &mut P,
-    backend: &Backend,
-    from_folder: &str,
-    to_folder: &str,
-    ids: Vec<&str>,
-) -> Result<()> {
-    backend
-        .copy_messages(&from_folder, &to_folder, &ids)
-        .await?;
-    printer.print("Email(s) successfully copied!")
-}
-
-pub async fn delete<P: Printer>(
-    printer: &mut P,
-    backend: &Backend,
-    folder: &str,
-    ids: Vec<&str>,
-) -> Result<()> {
-    backend.delete_messages(&folder, &ids).await?;
-    printer.print("Email(s) successfully deleted!")
-}
-
 pub async fn forward<P: Printer>(
     config: &AccountConfig,
     printer: &mut P,
@@ -147,60 +124,6 @@ pub async fn mailto<P: Printer>(
     editor::edit_tpl_with_editor(config, printer, backend, tpl).await
 }
 
-pub async fn move_<P: Printer>(
-    printer: &mut P,
-    backend: &Backend,
-    from_folder: &str,
-    to_folder: &str,
-    ids: Vec<&str>,
-) -> Result<()> {
-    backend
-        .move_messages(&from_folder, &to_folder, &ids)
-        .await?;
-    printer.print("Email(s) successfully moved!")
-}
-
-pub async fn read<P: Printer>(
-    config: &AccountConfig,
-    printer: &mut P,
-    backend: &Backend,
-    folder: &str,
-    ids: Vec<&str>,
-    text_mime: &str,
-    raw: bool,
-    headers: Vec<&str>,
-) -> Result<()> {
-    let emails = backend.get_messages(&folder, &ids).await?;
-
-    let mut glue = "";
-    let mut bodies = String::default();
-
-    for email in emails.to_vec() {
-        bodies.push_str(glue);
-
-        if raw {
-            // emails do not always have valid utf8, uses "lossy" to
-            // display what can be displayed
-            bodies.push_str(&String::from_utf8_lossy(email.raw()?).into_owned());
-        } else {
-            let tpl: String = email
-                .to_read_tpl(&config, |tpl| match text_mime {
-                    "html" => tpl
-                        .with_hide_all_headers()
-                        .with_filter_parts(FilterParts::Only("text/html".into())),
-                    _ => tpl.with_show_additional_headers(&headers),
-                })
-                .await?
-                .into();
-            bodies.push_str(&tpl);
-        }
-
-        glue = "\n\n";
-    }
-
-    printer.print(bodies)
-}
-
 pub async fn reply<P: Printer>(
     config: &AccountConfig,
     printer: &mut P,
@@ -230,61 +153,6 @@ pub async fn reply<P: Printer>(
     Ok(())
 }
 
-pub async fn save<P: Printer>(
-    printer: &mut P,
-    backend: &Backend,
-    folder: &str,
-    raw_email: String,
-) -> Result<()> {
-    let is_tty = atty::is(Stream::Stdin);
-    let is_json = printer.is_json();
-    let raw_email = if is_tty || is_json {
-        raw_email.replace("\r", "").replace("\n", "\r\n")
-    } else {
-        io::stdin()
-            .lock()
-            .lines()
-            .filter_map(Result::ok)
-            .collect::<Vec<String>>()
-            .join("\r\n")
-    };
-
-    backend
-        .add_raw_message(&folder, raw_email.as_bytes())
-        .await?;
-
-    Ok(())
-}
-
-pub async fn send<P: Printer>(
-    config: &AccountConfig,
-    printer: &mut P,
-    backend: &Backend,
-    raw_email: String,
-) -> Result<()> {
-    let folder = config.sent_folder_alias()?;
-    let is_tty = atty::is(Stream::Stdin);
-    let is_json = printer.is_json();
-    let raw_email = if is_tty || is_json {
-        raw_email.replace("\r", "").replace("\n", "\r\n")
-    } else {
-        io::stdin()
-            .lock()
-            .lines()
-            .filter_map(Result::ok)
-            .collect::<Vec<String>>()
-            .join("\r\n")
-    };
-    trace!("raw email: {:?}", raw_email);
-    backend.send_raw_message(raw_email.as_bytes()).await?;
-    if config.email_sending_save_copy.unwrap_or_default() {
-        backend
-            .add_raw_message_with_flag(&folder, raw_email.as_bytes(), Flag::Seen)
-            .await?;
-    }
-    Ok(())
-}
-
 pub async fn write<P: Printer>(
     config: &AccountConfig,
     printer: &mut P,

src/email/message/mod.rs

@@ -1,4 +1,5 @@
-pub mod args;
+// pub mod args;
+pub mod command;
 pub mod config;
-pub mod handlers;
-pub mod template;
+// pub mod handlers;
+// pub mod template;