rust/lettre
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #296 from amousset/failure

Browse Source 
feat(all): Start using the failure crate for errors
This commit is contained in:
Alexis Mousset
2018-05-31 13:15:14 +02:00
committed by GitHub
parent 9d14630552 c10fe3db84
commit c09e3ff8cd
9 changed files with 101 additions and 156 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
lettre/Cargo.toml
View File

@@ -28,6 +28,8 @@ hostname = { version = "^0.1", optional = true }
serde = { version = "^1.0", optional = true }
serde_json = { version = "^1.0", optional = true }
serde_derive = { version = "^1.0", optional = true }
failure = "^0.1"
failure_derive = "^0.1"
[dev-dependencies]
env_logger = "^0.5"

18
lettre/src/error.rs Normal file
View File

@@ -0,0 +1,18 @@
use failure;
/// Error type for email content
#[derive(Fail, Debug, Clone, Copy)]
pub enum Error {
/// Missing from in envelope
#[fail(display = "missing source address, invalid envelope")]
MissingFrom,
/// Missing to in envelope
#[fail(display = "missing destination address, invalid envelope")]
MissingTo,
/// Invalid email
#[fail(display = "invalid email address")]
InvalidEmailAddress,
}
/// Email result type
pub type EmailResult<T> = Result<T, failure::Error>;

47
lettre/src/file/error.rs
View File

@@ -1,63 +1,40 @@
//! Error and result type for file transport
use self::Error::*;
use failure;
use serde_json;
use std::error::Error as StdError;
use std::fmt::{self, Display, Formatter};
use std::io;
/// An enum of all error kinds.
#[derive(Debug)]
#[derive(Fail, Debug)]
pub enum Error {
/// Internal client error
Client(&'static str),
#[fail(display = "Internal client error: {}", error)]
Client { error: &'static str },
/// IO error
Io(io::Error),
#[fail(display = "IO error: {}", error)]
Io { error: io::Error },
/// JSON serialization error
JsonSerialization(serde_json::Error),
}
impl Display for Error {
fn fmt(&self, fmt: &mut Formatter) -> Result<(), fmt::Error> {
fmt.write_str(self.description())
}
}
impl StdError for Error {
fn description(&self) -> &str {
match *self {
Client(err) => err,
Io(ref err) => err.description(),
JsonSerialization(ref err) => err.description(),
}
}
fn cause(&self) -> Option<&StdError> {
match *self {
Io(ref err) => Some(&*err),
JsonSerialization(ref err) => Some(&*err),
_ => None,
}
}
#[fail(display = "JSON serialization error: {}", error)]
JsonSerialization { error: serde_json::Error },
}
impl From<io::Error> for Error {
fn from(err: io::Error) -> Error {
Io(err)
Error::Io { error: err }
}
}
impl From<serde_json::Error> for Error {
fn from(err: serde_json::Error) -> Error {
JsonSerialization(err)
Error::JsonSerialization { error: err }
}
}
impl From<&'static str> for Error {
fn from(string: &'static str) -> Error {
Client(string)
Error::Client { error: string }
}
}
/// SMTP result type
pub type FileResult = Result<(), Error>;
pub type FileResult = Result<(), failure::Error>;

46
lettre/src/lib.rs
View File

@@ -6,7 +6,7 @@
#![doc(html_root_url = "https://docs.rs/lettre/0.9.0")]
#![deny(
missing_copy_implementations, trivial_casts, trivial_numeric_casts, unsafe_code,
unstable_features, unused_import_braces, unused_qualifications
unstable_features, unused_import_braces
)]
#[cfg(feature = "smtp-transport")]
extern crate base64;
@@ -26,9 +26,13 @@ extern crate serde;
#[cfg(feature = "serde-impls")]
#[macro_use]
extern crate serde_derive;
extern crate failure;
#[cfg(feature = "file-transport")]
extern crate serde_json;
#[macro_use]
extern crate failure_derive;
pub mod error;
#[cfg(feature = "file-transport")]
pub mod file;
#[cfg(feature = "sendmail-transport")]
@@ -37,6 +41,9 @@ pub mod sendmail;
pub mod smtp;
pub mod stub;
use error::EmailResult;
use error::Error as EmailError;
use failure::Error;
#[cfg(feature = "file-transport")]
pub use file::FileTransport;
#[cfg(feature = "sendmail-transport")]
@@ -45,47 +52,12 @@ pub use sendmail::SendmailTransport;
pub use smtp::client::net::ClientTlsParameters;
#[cfg(feature = "smtp-transport")]
pub use smtp::{ClientSecurity, SmtpClient, SmtpTransport};
use std::error::Error as StdError;
use std::fmt::{self, Display, Formatter};
use std::io;
use std::io::Cursor;
use std::io::Read;
use std::str::FromStr;
/// Error type for email content
#[derive(Debug, Clone, Copy)]
pub enum Error {
/// Missing from in envelope
MissingFrom,
/// Missing to in envelope
MissingTo,
/// Invalid email
InvalidEmailAddress,
}
impl StdError for Error {
fn description(&self) -> &str {
match *self {
Error::MissingFrom => "missing source address, invalid envelope",
Error::MissingTo => "missing destination address, invalid envelope",
Error::InvalidEmailAddress => "invalid email address",
}
}
fn cause(&self) -> Option<&StdError> {
None
}
}
impl Display for Error {
fn fmt(&self, fmt: &mut Formatter) -> Result<(), fmt::Error> {
fmt.write_str(self.description())
}
}
/// Email result type
pub type EmailResult<T> = Result<T, Error>;
/// Email address
#[derive(PartialEq, Eq, Clone, Debug)]
#[cfg_attr(feature = "serde-impls", derive(Serialize, Deserialize))]
@@ -131,7 +103,7 @@ impl Envelope {
/// Creates a new envelope, which may fail if `to` is empty.
pub fn new(from: Option<EmailAddress>, to: Vec<EmailAddress>) -> EmailResult<Envelope> {
if to.is_empty() {
return Err(Error::MissingTo);
Err(EmailError::MissingTo)?;
}
Ok(Envelope {
forward_path: to,

40
lettre/src/sendmail/error.rs
View File

@@ -1,52 +1,30 @@
//! Error and result type for sendmail transport
use self::Error::*;
use std::error::Error as StdError;
use std::fmt::{self, Display, Formatter};
use failure;
use std::io;
/// An enum of all error kinds.
#[derive(Debug)]
#[derive(Fail, Debug)]
pub enum Error {
/// Internal client error
Client(&'static str),
#[fail(display = "Internal client error: {}", error)]
Client { error: &'static str },
/// IO error
Io(io::Error),
}
impl Display for Error {
fn fmt(&self, fmt: &mut Formatter) -> Result<(), fmt::Error> {
fmt.write_str(self.description())
}
}
impl StdError for Error {
fn description(&self) -> &str {
match *self {
Client(err) => err,
Io(ref err) => err.description(),
}
}
fn cause(&self) -> Option<&StdError> {
match *self {
Io(ref err) => Some(&*err),
_ => None,
}
}
#[fail(display = "IO error: {}", error)]
Io { error: io::Error },
}
impl From<io::Error> for Error {
fn from(err: io::Error) -> Error {
Io(err)
Error::Io { error: err }
}
}
impl From<&'static str> for Error {
fn from(string: &'static str) -> Error {
Client(string)
Error::Client { error: string }
}
}
/// sendmail result type
pub type SendmailResult = Result<(), Error>;
pub type SendmailResult = Result<(), failure::Error>;

23
lettre/src/sendmail/mod.rs
View File

@@ -58,26 +58,23 @@ impl<'a> Transport<'a> for SendmailTransport {
let mut message_content = String::new();
let _ = email.message().read_to_string(&mut message_content);
match process
process
.stdin
.as_mut()
.unwrap()
.write_all(message_content.as_bytes())
{
Ok(_) => (),
Err(error) => return Err(From::from(error)),
}
.write_all(message_content.as_bytes())?;
info!("Wrote {} message to stdin", message_id);
if let Ok(output) = process.wait_with_output() {
if output.status.success() {
Ok(())
} else {
Err(From::from("The message could not be sent"))
}
let output = process.wait_with_output()?;
if output.status.success() {
Ok(())
} else {
Err(From::from("The sendmail process stopped"))
// TODO display stderr
Err(error::Error::Client {
error: "The message could not be sent",
})?
}
}
}

2
lettre_email/Cargo.toml
View File

@@ -29,3 +29,5 @@ time = "^0.1"
uuid = { version = "^0.6", features = ["v4"] }
lettre = { version = "^0.9", path = "../lettre", default-features = false }
base64 = "^0.9"
failure = "^0.1"
failure_derive = "^0.1"

45
lettre_email/src/error.rs
View File

@@ -1,47 +1,36 @@
//! Error and result type for emails
use self::Error::*;
use std::error::Error as StdError;
use std::fmt::{self, Display, Formatter};
use lettre;
use std::io;
use lettre;
/// An enum of all error kinds.
#[derive(Debug)]
#[derive(Debug, Fail)]
pub enum Error {
/// Envelope error
Email(lettre::Error),
#[fail(display = "lettre error: {}", error)]
Envelope {
/// inner error
error: lettre::error::Error,
},
/// Unparseable filename for attachment
#[fail(display = "the attachment filename could not be parsed")]
CannotParseFilename,
/// IO error
Io(io::Error),
}
impl Display for Error {
fn fmt(&self, fmt: &mut Formatter) -> Result<(), fmt::Error> {
fmt.write_str(self.description())
}
}
impl StdError for Error {
fn description(&self) -> &str {
match *self {
Email(ref err) => err.description(),
CannotParseFilename => "the attachment filename could not be parsed",
Io(ref err) => err.description(),
}
}
#[fail(display = "IO error: {}", error)]
Io {
/// inner error
error: io::Error,
},
}
impl From<io::Error> for Error {
fn from(err: io::Error) -> Error {
Io(err)
Error::Io { error: err }
}
}
impl From<lettre::Error> for Error {
fn from(err: lettre::Error) -> Error {
Email(err)
impl From<lettre::error::Error> for Error {
fn from(err: lettre::error::Error) -> Error {
Error::Envelope { error: err }
}
}

34
lettre_email/src/lib.rs
View File

@@ -4,10 +4,13 @@
#![doc(html_root_url = "https://docs.rs/lettre_email/0.9.0")]
#![deny(
missing_docs, missing_debug_implementations, missing_copy_implementations, trivial_casts,
trivial_numeric_casts, unsafe_code, unstable_features, unused_import_braces,
unused_qualifications
trivial_numeric_casts, unsafe_code, unstable_features, unused_import_braces
)]
extern crate failure;
#[macro_use]
extern crate failure_derive;
extern crate base64;
extern crate email as email_format;
extern crate lettre;
@@ -18,8 +21,9 @@ extern crate uuid;
pub mod error;
pub use email_format::{Address, Header, Mailbox, MimeMessage, MimeMultipartType};
use error::Error;
use lettre::{EmailAddress, Envelope, Error as EmailError, SendableEmail};
use error::Error as EmailError;
use failure::Error;
use lettre::{error::Error as LettreError, EmailAddress, Envelope, SendableEmail};
use mime::Mime;
use std::fs;
use std::path::Path;
@@ -231,7 +235,7 @@ impl EmailBuilder {
fs::read(path)?.as_slice(),
filename.unwrap_or(path.file_name()
.and_then(|x| x.to_str())
.ok_or(Error::CannotParseFilename)?),
.ok_or(EmailError::CannotParseFilename)?),
content_type,
)
}
@@ -369,26 +373,30 @@ impl EmailBuilder {
}
}
let from = Some(EmailAddress::from_str(&match self.sender {
Some(x) => x.address.clone(), // if we have a sender_header, use it
Some(x) => Ok(x.address.clone()), // if we have a sender_header, use it
None => {
// use a from header
debug_assert!(self.from.len() <= 1); // else we'd have sender_header
match self.from.first() {
Some(a) => match *a {
// if we have a from header
Address::Mailbox(ref mailbox) => mailbox.address.clone(), // use it
Address::Mailbox(ref mailbox) => Ok(mailbox.address.clone()), // use it
Address::Group(_, ref mailbox_list) => match mailbox_list.first() {
// if it's an author group, use the first author
Some(mailbox) => mailbox.address.clone(),
Some(mailbox) => Ok(mailbox.address.clone()),
// for an empty author group (the rarest of the rare cases)
None => return Err(Error::Email(EmailError::MissingFrom)), // empty envelope sender
None => Err(EmailError::Envelope {
error: LettreError::MissingFrom,
}), // empty envelope sender
},
},
// if we don't have a from header
None => return Err(Error::Email(EmailError::MissingFrom)), // empty envelope sender
None => Err(EmailError::Envelope {
error: LettreError::MissingFrom,
}), // empty envelope sender
}
}
})?);
}?)?);
Envelope::new(from, to)?
}
};
@@ -402,7 +410,9 @@ impl EmailBuilder {
self.message = self.message
.header(Header::new_with_value("From".into(), self.from).unwrap());
} else {
return Err(Error::Email(EmailError::MissingFrom));
Err(EmailError::Envelope {
error: LettreError::MissingFrom,
})?;
}
if !self.cc.is_empty() {
self.message = self.message