lettre 0.10.1

Email client
Documentation

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

Supported Rust Versions

Lettre supports all Rust versions released in the last 6 months. At the time of writing the minimum supported Rust version is 1.56, but this could change at any time either from one of our dependencies bumping their MSRV or by a new patch release of lettre.

Example

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

[dependencies]
lettre = "0.10"

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

let email = Message::builder()
    .from("NoBody <nobody@domain.tld>".parse().unwrap())
    .reply_to("Yuin <yuin@domain.tld>".parse().unwrap())
    .to("Hei <hei@domain.tld>".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),
}

Not sure of which connect options to use?

Clone the lettre git repository and run the following command (replacing SMTP_HOST with your SMTP server's hostname)

cargo run --example autoconfigure SMTP_HOST

Testing

The lettre tests require an open mail server listening locally on port 2525 and the sendmail command. If you have python installed such a server can be launched with python -m smtpd -n -c DebuggingServer 127.0.0.1:2525

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

Troubleshooting

These are general steps to be followed when troubleshooting SMTP related issues.

  • Ensure basic connectivity, ensure requisite ports are open and daemons are listening.
  • Confirm that your service provider allows traffic on the ports being used for mail transfer.
  • Check SMTP relay authentication and configuration.
  • Validate your DNS records. (DMARC, SPF, DKIM, MX)
  • Verify your SSL/TLS certificates are setup properly.
  • Investigate if filtering, formatting, or filesize limits are causing messages to be lost, delayed, or blocked by relays or remote hosts.

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.