From 9f99382b981cbfbe35d64a238373b6aed40ae947 Mon Sep 17 00:00:00 2001 From: Alexis Mousset Date: Wed, 10 Dec 2014 13:57:29 +0100 Subject: [PATCH] Document SendableEmail --- src/lib.rs | 2 +- src/sendable_email.rs | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 05dbd57..3dc57df 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -113,7 +113,7 @@ #![experimental] #![feature(phase, macro_rules, default_type_params)] -//#![deny(missing_docs, warnings)] +#![deny(missing_docs, warnings)] #![feature(phase)] #[phase(plugin, link)] extern crate log; diff --git a/src/sendable_email.rs b/src/sendable_email.rs index c06d3ef..9d8728e 100644 --- a/src/sendable_email.rs +++ b/src/sendable_email.rs @@ -9,10 +9,12 @@ //! SMTP sendable email -/// Converts to an `Header` +/// Email sendable by an SMTP client pub trait SendableEmail { - /// Converts to an `Header` struct + /// From address fn from_address(&self) -> String; + /// To addresses fn to_addresses(&self) -> Vec; + /// Message content fn message(&self) -> String; }