README.md

lettre

Lettre is a mailer library for Rust.

Useful links:

• User documentation
• API documentation
• Changelog

---

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

Example

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

[dependencies]
lettre = "0.9"

extern crate lettre;

use lettre::{SmtpClient, Transport, Email, builder::mime::TEXT_PLAIN};
use std::path::Path;

fn main() {
    let email = Email::builder()
        // Addresses can be specified by the tuple (email, alias)
        .to(("user@example.org", "Firstname Lastname"))
        // ... or by an address only
        .from("user@example.com")
        .subject("Hi, Hello world")
        .text("Hello world.")
        .attachment_from_file(Path::new("Cargo.toml"), None, &TEXT_PLAIN)
        .unwrap()
        .build()
        .unwrap();

    // Open a local connection on port 25
    let mut mailer = SmtpClient::new_unencrypted_localhost().unwrap().transport();
    // Send the email
    let result = mailer.send(email);

    if result.is_ok() {
        println!("Email sent");
    } else {
        println!("Could not send email: {:?}", result);
    }

    assert!(result.is_ok());
}

Testing

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

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.

See LICENSE for details.