feat: email support using lettre

Cargo.toml

@@ -7,6 +7,7 @@ members = [
     # Examples
     "examples/admin",
     "examples/custom-error-pages",
+    "examples/send-email",
     "examples/custom-task",
     "examples/file-upload",
     "examples/hello-world",
@@ -92,6 +93,7 @@ humantime = "2"
 indexmap = "2"
 insta = { version = "1", features = ["filters"] }
 insta-cmd = "0.6"
+lettre = { version = "0.11", features = ["smtp-transport", "builder", "native-tls"] }
 mime_guess = { version = "2", default-features = false }
 mockall = "0.13"
 multer = "3"

cot/Cargo.toml

@@ -40,6 +40,7 @@ http-body.workspace = true
 http.workspace = true
 humantime.workspace = true
 indexmap.workspace = true
+lettre.workspace = true
 mime_guess.workspace = true
 multer.workspace = true
 password-auth = { workspace = true, features = ["std", "argon2"] }

cot/src/config.rs

@@ -22,6 +22,8 @@ use derive_more::with_trait::{Debug, From};
 use serde::{Deserialize, Serialize};
 use subtle::ConstantTimeEq;
 
+use crate::email;
+
 /// The configuration for a project.
 ///
 /// This is all the project-specific configuration data that can (and makes
@@ -211,6 +213,24 @@ pub struct ProjectConfig {
     /// # Ok::<(), cot::Error>(())
     /// ```
     pub middlewares: MiddlewareConfig,
+    /// Configuration related to the email backend.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use cot::config::{EmailBackendConfig, ProjectConfig};
+    ///
+    /// let config = ProjectConfig::from_toml(
+    ///     r#"
+    /// [email_backend]
+    /// type = "none"
+    /// "#,
+    /// )?;
+    ///
+    /// assert_eq!(config.email_backend, EmailBackendConfig::default());
+    /// # Ok::<(), cot::Error>(())
+    /// ```
+    pub email_backend: EmailBackendConfig,
 }
 
 const fn default_debug() -> bool {
@@ -313,6 +333,7 @@ impl ProjectConfigBuilder {
             database: self.database.clone().unwrap_or_default(),
             static_files: self.static_files.clone().unwrap_or_default(),
             middlewares: self.middlewares.clone().unwrap_or_default(),
+            email_backend: self.email_backend.clone().unwrap_or_default(),
         }
     }
 }
@@ -809,7 +830,104 @@ impl SessionMiddlewareConfigBuilder {
         }
     }
 }
+/// The type of email backend to use.
+#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
+pub enum EmailBackendType {
+    /// No email backend.
+    #[default]
+    None,
+    /// SMTP email backend.
+    Smtp,
+}
+/// The configuration for the SMTP backend.
+///
+/// This is used as part of the [`EmailBackendConfig`] enum.
+///
+/// # Examples
+///
+/// ```
+/// use cot::config::EmailBackendConfig;
+///
+/// let config = EmailBackendConfig::builder().build();
+/// ```
+#[derive(Debug, Default, Clone, PartialEq, Eq, Builder, Serialize, Deserialize)]
+#[builder(build_fn(skip, error = std::convert::Infallible))]
+#[serde(default)]
+pub struct EmailBackendConfig {
+    /// The type of email backend to use.
+    /// Defaults to `None`.
+    #[builder(setter(into, strip_option), default)]
+    pub backend_type: EmailBackendType,
+    /// The SMTP server host address.
+    /// Defaults to "localhost".
+    #[builder(setter(into, strip_option), default)]
+    pub smtp_mode: email::SmtpTransportMode,
+    /// The SMTP server port.
+    /// Overwrites the default standard port when specified.
+    #[builder(setter(into, strip_option), default)]
+    pub port: Option<u16>,
+    /// The username for SMTP authentication.
+    #[builder(setter(into, strip_option), default)]
+    pub username: Option<String>,
+    /// The password for SMTP authentication.
+    #[builder(setter(into, strip_option), default)]
+    pub password: Option<String>,
+    /// The timeout duration for the SMTP connection.
+    #[builder(setter(into, strip_option), default)]
+    pub timeout: Option<Duration>,
+}
 
+impl EmailBackendConfig {
+    /// Create a new [`EmailBackendConfigBuilder`] to build a
+    /// [`EmailBackendConfig`].
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use cot::config::EmailBackendConfig;
+    ///
+    /// let config = EmailBackendConfig::builder().build();
+    /// ```
+    #[must_use]
+    pub fn builder() -> EmailBackendConfigBuilder {
+        EmailBackendConfigBuilder::default()
+    }
+}
+impl EmailBackendConfigBuilder {
+    /// Builds the email configuration.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use cot::config::EmailBackendConfig;
+    ///
+    /// let config = EmailBackendConfig::builder().build();
+    /// ```
+    #[must_use]
+    pub fn build(&self) -> EmailBackendConfig {
+        match self.backend_type.clone().unwrap_or(EmailBackendType::None) {
+            EmailBackendType::Smtp => EmailBackendConfig {
+                backend_type: EmailBackendType::Smtp,
+                smtp_mode: self
+                    .smtp_mode
+                    .clone()
+                    .unwrap_or(email::SmtpTransportMode::Localhost),
+                port: self.port.unwrap_or_default(),
+                username: self.username.clone().unwrap_or_default(),
+                password: self.password.clone().unwrap_or_default(),
+                timeout: self.timeout.unwrap_or_default(),
+            },
+            EmailBackendType::None => EmailBackendConfig {
+                backend_type: EmailBackendType::None,
+                smtp_mode: email::SmtpTransportMode::Localhost,
+                port: None,
+                username: None,
+                password: None,
+                timeout: None,
+            },
+        }
+    }
+}
 /// A secret key.
 ///
 /// This is a wrapper over a byte array, which is used to store a cryptographic
@@ -1024,6 +1142,8 @@ mod tests {
             live_reload.enabled = true
             [middlewares.session]
             secure = false
+            [email_backend]
+            type = "none"
         "#;
 
         let config = ProjectConfig::from_toml(toml_content).unwrap();
@@ -1046,6 +1166,7 @@ mod tests {
         );
         assert!(config.middlewares.live_reload.enabled);
         assert!(!config.middlewares.session.secure);
+        assert_eq!(config.email_backend.backend_type, EmailBackendType::None);
     }
 
     #[test]