alexwennerberg / lettre

a mailer library for Rust

lettre

A mailer library for Rust

---

NOTE: this readme refers to the 0.10 version of lettre, which is still being worked on. The master branch and the alpha releases will see API breaking changes and some features may be missing or incomplete until the stable 0.10.0 release is out. Use the v0.9.x branch for stable releases.

---

Features

Lettre provides the following features:

• Multiple transport methods
• Unicode support (for email content and addresses)
• Secure delivery with SMTP using encryption and authentication
• Easy email builders
• Async support

Lettre does not provide (for now):

• Email parsing

Example

This library requires Rust 1.46 or newer. To use this library, add the following to your Cargo.toml:

[dependencies]
lettre = "0.10.0-beta.3"

use lettre::transport::smtp::authentication::Credentials;
use lettre::{Message, SmtpTransport, Transport};

let email = Message::builder()
    .from("NoBody <[email protected]>".parse().unwrap())
    .reply_to("Yuin <[email protected]>".parse().unwrap())
    .to("Hei <[email protected]>".parse().unwrap())
    .subject("Happy new year")
    .body(String::from("Be happy!"))
    .unwrap();

let creds = Credentials::new("smtp_username".to_string(), "smtp_password".to_string());

// Open a remote connection to gmail
let mailer = SmtpTransport::relay("smtp.gmail.com")
    .unwrap()
    .credentials(creds)
    .build();

// Send the email
match mailer.send(&email) {
    Ok(_) => println!("Email sent successfully!"),
    Err(e) => panic!("Could not send email: {:?}", e),
}

Testing

The lettre tests require an open mail server listening locally on port 2525 and the sendmail command.

Alternatively only unit tests can be run by doing cargo test --lib.

Code of conduct

Anyone who interacts with Lettre in any space, including but not limited to this GitHub repository, must follow our code of conduct.

License

This program is distributed under the terms of the MIT license.

The builder comes from emailmessage-rs by Kayo, under MIT license.

See LICENSE for details.