From 7a9f9111a527585c98f8e6cb7dd133c4aec6e319 Mon Sep 17 00:00:00 2001 From: Alexis Mousset Date: Sat, 16 Jan 2016 12:13:06 +0100 Subject: [PATCH] Improve doc --- Cargo.toml | 2 +- benches/transport_smtp.rs | 6 +- src/lib.rs | 135 +++++++++++++++++++------------------- 3 files changed, 73 insertions(+), 70 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 5f72eea..106e8da 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "lettre" -version = "0.5.0" +version = "0.5.1" description = "Email client" readme = "README.md" documentation = "http://lettre.github.io/lettre/" diff --git a/benches/transport_smtp.rs b/benches/transport_smtp.rs index 3d785d0..1f8d332 100644 --- a/benches/transport_smtp.rs +++ b/benches/transport_smtp.rs @@ -26,9 +26,9 @@ fn bench_simple_send(b: &mut test::Bencher) { #[bench] fn bench_reuse_send(b: &mut test::Bencher) { let mut sender = SmtpTransportBuilder::new("127.0.0.1:2525") - .unwrap() - .connection_reuse(true) - .build(); + .unwrap() + .connection_reuse(true) + .build(); b.iter(|| { let email = EmailBuilder::new() .to("root@localhost") diff --git a/src/lib.rs b/src/lib.rs index c66936f..8ace05c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -5,72 +5,8 @@ //! This mailer is divided into: //! //! * An `email` part: builds the email message -//! * A `transport` part: contains the available transports for your emails. To be sendable, the emails have to implement `SendableEmail`. -//! -//! ## Stub transport -//! -//! The stub transport only logs message envelope and drops the content. It can be useful for testing purposes. -//! -//! ```rust -//! use lettre::transport::stub::StubEmailTransport; -//! use lettre::transport::EmailTransport; -//! use lettre::email::EmailBuilder; -//! -//! let mut sender = StubEmailTransport; -//! let email = EmailBuilder::new() -//! .to("root@localhost") -//! .from("user@localhost") -//! .body("Hello World!") -//! .subject("Hello") -//! .build() -//! .unwrap(); -//! let result = sender.send(email); -//! assert!(result.is_ok()); -//! ``` -//! -//! Will log the line: -//! -//! ```text -//! b7c211bc-9811-45ce-8cd9-68eab575d695: from= to= -//! ``` -//! -//! ## File transport -//! -//! The file transport writes the emails to the given directory. The name of the file will be `message_id.txt`. -//! It can be useful for testing purposes. -//! -//! ```rust -//! use std::env::temp_dir; -//! -//! use lettre::transport::file::FileEmailTransport; -//! use lettre::transport::EmailTransport; -//! use lettre::email::{EmailBuilder, SendableEmail}; -//! -//! // Write to the local temp directory -//! let mut sender = FileEmailTransport::new(temp_dir()); -//! let email = EmailBuilder::new() -//! .to("root@localhost") -//! .from("user@localhost") -//! .body("Hello World!") -//! .subject("Hello") -//! .build() -//! .unwrap(); -//! -//! let result = sender.send(email); -//! assert!(result.is_ok()); -//! ``` -//! Example result in `/tmp/b7c211bc-9811-45ce-8cd9-68eab575d695.txt`: -//! -//! ```text -//! b7c211bc-9811-45ce-8cd9-68eab575d695: from= to= -//! To: -//! From: -//! Subject: Hello -//! Date: Sat, 31 Oct 2015 13:42:19 +0100 -//! Message-ID: -//! -//! Hello World! -//! ``` +//! * A `transport` part: contains the available transports for your emails. To be sendable, the +//! emails have to implement `SendableEmail`. //! //! ## SMTP transport //! @@ -188,6 +124,73 @@ //! let _ = email_client.message("Test email"); //! let _ = email_client.quit(); //! ``` +//! +//! ## Stub transport +//! +//! The stub transport only logs message envelope and drops the content. It can be useful for +//! testing purposes. +//! +//! ```rust +//! use lettre::transport::stub::StubEmailTransport; +//! use lettre::transport::EmailTransport; +//! use lettre::email::EmailBuilder; +//! +//! let mut sender = StubEmailTransport; +//! let email = EmailBuilder::new() +//! .to("root@localhost") +//! .from("user@localhost") +//! .body("Hello World!") +//! .subject("Hello") +//! .build() +//! .unwrap(); +//! let result = sender.send(email); +//! assert!(result.is_ok()); +//! ``` +//! +//! Will log the line: +//! +//! ```text +//! b7c211bc-9811-45ce-8cd9-68eab575d695: from= to= +//! ``` +//! +//! ## File transport +//! +//! The file transport writes the emails to the given directory. The name of the file will be +//! `message_id.txt`. +//! It can be useful for testing purposes. +//! +//! ```rust +//! use std::env::temp_dir; +//! +//! use lettre::transport::file::FileEmailTransport; +//! use lettre::transport::EmailTransport; +//! use lettre::email::{EmailBuilder, SendableEmail}; +//! +//! // Write to the local temp directory +//! let mut sender = FileEmailTransport::new(temp_dir()); +//! let email = EmailBuilder::new() +//! .to("root@localhost") +//! .from("user@localhost") +//! .body("Hello World!") +//! .subject("Hello") +//! .build() +//! .unwrap(); +//! +//! let result = sender.send(email); +//! assert!(result.is_ok()); +//! ``` +//! Example result in `/tmp/b7c211bc-9811-45ce-8cd9-68eab575d695.txt`: +//! +//! ```text +//! b7c211bc-9811-45ce-8cd9-68eab575d695: from= to= +//! To: +//! From: +//! Subject: Hello +//! Date: Sat, 31 Oct 2015 13:42:19 +0100 +//! Message-ID: +//! +//! Hello World! +//! ``` #![deny(missing_docs, unsafe_code, unstable_features)]