Add conditional compilation flags for email clients

Features such as "mailersend", "terminal", "smtp", "memory", and "document-features" on certain imports and functions have been added. This enables these functionalities to be included or excluded at compile-time, depending on the required configuration. This provides greater flexibility and can optimize the build size and time for different usage scenarios.
amritghimire · Apr 28, 2024 · a2ac525 · a2ac525
1 parent ae56080
commit a2ac525
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/src/clients/mod.rs b/src/clients/mod.rs
@@ -1,4 +1,6 @@
+#[cfg(any(feature = "mailersend", feature = "terminal", feature = "smtp", feature = "memory", feature = "document-features"))]
 use crate::configuration::EmailConfiguration;
+#[cfg(any(feature = "mailersend", feature = "terminal", feature = "smtp", feature = "memory", feature = "document-features"))]
 use crate::traits::EmailTrait;
 
 #[cfg_attr(docsrs, doc(cfg(feature = "smtp")))]
@@ -17,6 +19,7 @@ pub mod terminal;
 #[cfg(feature = "mailersend")]
 pub mod mailersend;
 
+#[cfg(any(feature = "mailersend", feature = "terminal", feature = "smtp", feature = "memory", feature = "document-features"))]
 ///`EmailClient` Enum representing different types of email clients.
 ///Currently supported email clients: SMTP, Terminal, Memory.
 ///
@@ -94,6 +97,7 @@ impl Default for EmailClient {
     }
 }
 
+#[cfg(any(feature = "mailersend", feature = "terminal", feature = "smtp", feature = "memory", feature = "document-features"))]
 pub fn get_email_client(configuration: EmailConfiguration) -> EmailClient {
     match configuration {
         #[cfg(feature = "terminal")]
@@ -111,6 +115,7 @@ pub fn get_email_client(configuration: EmailConfiguration) -> EmailClient {
     }
 }
 
+#[cfg(any(feature = "mailersend", feature = "terminal", feature = "smtp", feature = "memory", feature = "document-features"))]
 impl EmailClient {
     /// Unwrap the `EmailClient` enum variant and convert it into a `Box<dyn EmailTrait + Send>`.
     ///

diff --git a/src/lib.rs b/src/lib.rs
@@ -15,7 +15,9 @@
 //!
 //!```rust
 //! use std::sync::mpsc;
+//! # #[cfg(any(feature = "mailersend", feature = "terminal", feature = "smtp", feature = "memory", feature = "document-features"))]
 //! use email_clients::clients::{EmailClient, get_email_client};
+//! # #[cfg(feature = "mailersend")]
 //! use email_clients::clients::mailersend::MailerSendConfig;
 //! # #[cfg(feature = "memory")]
 //! use email_clients::clients::memory::{MemoryClient, MemoryConfig};

diff --git a/tests/clients.rs b/tests/clients.rs
@@ -1,8 +1,10 @@
+#[cfg(any(feature = "mailersend", feature = "terminal", feature = "smtp", feature = "memory", feature = "document-features"))]
 use email_clients::clients::get_email_client;
 #[cfg(feature = "memory")]
 use email_clients::clients::memory::MemoryConfig;
 #[cfg(feature = "smtp")]
 use email_clients::clients::smtp::SmtpConfig;
+#[cfg(any(feature = "mailersend", feature = "terminal", feature = "smtp", feature = "memory", feature = "document-features"))]
 use email_clients::configuration::EmailConfiguration;
 
 #[cfg(feature = "terminal")]