Update documentation and add cc method

src/email/address.rs

@@ -7,15 +7,15 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Simple SMTP "address"
+//! Simple SMTP "address" (very incomplete)
 
 use std::fmt::{Show, Formatter, Result};
 
 use common::SP;
 
-/// TODO
+/// Converts an adress or an address with an alias to an `Address`
 pub trait ToAddress {
-    /// TODO
+    /// Converts to an `Address` struct
     fn to_address(&self) -> Address;
 }
 
@@ -38,13 +38,12 @@ impl<'a> ToAddress for (&'a str, &'a str) {
     }
 }
 
-
-/// TODO
+/// Contains an address with an optionnal alias
 #[deriving(PartialEq,Eq,Clone)]
 pub struct Address {
-    /// TODO
+    /// The address
     address: String,
-    /// TODO
+    /// The alias
     alias: Option<String>,
 }
 
@@ -58,18 +57,18 @@ impl Show for Address {
 }
 
 impl Address {
-    /// TODO
+    /// Creates an address
     pub fn new(address: &str, alias: Option<&str>) -> Address {
-        Address{
+        Address {
             address: address.to_string(),
             alias: match alias {
-                    Some(ref alias_string) => Some(alias_string.to_string()),
-                    None => None,
-                }
+                Some(ref alias_string) => Some(alias_string.to_string()),
+                None => None,
+            }
         }
     }
 
-    /// TODO
+    /// Return only the address
     pub fn get_address(&self) -> String {
         self.address.clone()
     }

src/email/header.rs

@@ -13,12 +13,31 @@ use std::fmt::{Show, Formatter, Result};
 
 use common::{SP, COLON};
 
-/// TODO
+/// Converts to an `Header`
+pub trait ToHeader {
+    /// Converts to an `Header` struct
+    fn to_header(&self) -> Header;
+}
+
+impl ToHeader for Header {
+    fn to_header(&self) -> Header {
+        (*self).clone()
+    }
+}
+
+impl<'a> ToHeader for (&'a str, &'a str) {
+    fn to_header(&self) -> Header {
+        let (name, value) = *self;
+        Header::new(name, value)
+    }
+}
+
+/// Contains a header
 #[deriving(PartialEq,Eq,Clone)]
 pub struct Header {
-    /// TODO
+    /// Name of the header
     name: String,
-    /// TODO
+    /// Value of the header
     value: String,
 }
 
@@ -29,7 +48,7 @@ impl Show for Header {
 }
 
 impl Header {
-    /// TODO
+    /// Creates ah `Header`
     pub fn new(name: &str, value: &str) -> Header {
         Header{name: name.to_string(), value: value.to_string()}
     }

src/email/mod.rs

@@ -7,28 +7,28 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Simple email
+//! Simple email (very incomplete)
 
 use std::fmt::{Show, Formatter, Result};
 
 use time::{now, Tm};
 
-use email::header::Header;
+use email::header::{ToHeader, Header};
 use email::address::ToAddress;
 use common::CRLF;
 
 pub mod header;
 pub mod address;
 
-/// TODO
+/// Simple email representation
 pub struct Email {
     /// Array of headers
     headers: Vec<Header>,
     /// Message body
     body: String,
-    /// TODO cc bcc to
+    /// The enveloppe recipients addresses
     to: Vec<String>,
-    /// TODO
+    /// The enveloppe sender address
     from: Option<String>,
 }
 
@@ -44,12 +44,12 @@ impl Show for Email {
 }
 
 impl Email {
-    /// TODO
+    /// Creates a new empty email
     pub fn new() -> Email {
         Email{headers: vec!(), body: "".to_string(), to: vec!(), from: None}
     }
 
-    /// TODO
+    /// Clear the email content
     pub fn clear(&mut self) {
         self.headers.clear();
         self.body = "".to_string();
@@ -57,7 +57,7 @@ impl Email {
         self.from = None;
     }
 
-    /// TODO
+    /// Return the to addresses, and fails if it is not set
     pub fn get_to<'a>(&'a self) -> Vec<String> {
         if self.to.is_empty() {
             panic!("The To field is empty")
@@ -65,7 +65,7 @@ impl Email {
         self.to.clone()
     }
 
-    /// TODO
+    /// Return the from address, and fails if it is not set
     pub fn get_from(&self) -> String {
         match self.from {
             Some(ref from_address) => from_address.clone(),
@@ -73,19 +73,17 @@ impl Email {
         }
     }
 
-    // TODO : standard headers method
-
-    /// TODO
+    /// Sets the email body
     pub fn body(&mut self, body: &str) {
         self.body = body.to_string();
     }
 
-    /// TODO
-    pub fn add_header(&mut self, header: Header) {
-        self.headers.push(header);
+    /// Add a generic header
+    pub fn add_header<A: ToHeader>(&mut self, header: A) {
+        self.headers.push(header.to_header());
     }
 
-    /// TODO
+    /// Adds a From header and store the sender address
     pub fn from<A: ToAddress>(&mut self, address: A) {
         self.from = Some(address.to_address().get_address());
         self.headers.push(
@@ -93,7 +91,7 @@ impl Email {
         );
     }
 
-    /// TODO
+    /// Adds a To header and store the recipient address
     pub fn to<A: ToAddress>(&mut self, address: A) {
         self.to.push(address.to_address().get_address());
         self.headers.push(
@@ -101,21 +99,29 @@ impl Email {
         );
     }
 
-    /// TODO
+    /// Adds a Cc header and store the recipient address
+    pub fn cc<A: ToAddress>(&mut self, address: A) {
+        self.to.push(address.to_address().get_address());
+        self.headers.push(
+            Header::new("Cc", address.to_address().to_string().as_slice())
+        );
+    }
+
+    /// Adds a Reply-To header
     pub fn reply_to<A: ToAddress>(&mut self, address: A) {
         self.headers.push(
             Header::new("Return-Path", address.to_address().to_string().as_slice())
         );
     }
 
-    /// TODO
+    /// Adds a Subject header
     pub fn subject(&mut self, subject: &str) {
         self.headers.push(
             Header::new("Subject", subject)
         );
     }
 
-    /// TODO
+    /// Adds a Date header with the current time
     pub fn date(&mut self) {
         self.headers.push(
             Header::new("Date", Tm::rfc822(&now()).to_string().as_slice())

src/lib.rs

@@ -51,10 +51,13 @@
 //! use smtp::email::Email;
 //!
 //! let mut email = Email::new();
-//! email.to(("user@example.org", "Firstname Lastname"));
-//! email.from("user@example.com");
+//! email.to(("user@example.org", "Alias name"));
+//! email.cc(("user@example.net", "Alias name"));
+//! email.from("no-reply@example.com");
 //! email.subject("Hello world");
 //! email.body("Hi, Hello world.");
+//! email.reply_to("contact@example.com");
+//! email.add_header(("X-Custom-Header", "my header"));
 //! email.date();
 //!
 //! let mut client = Client::new(