mail-send is a Rust library to build, sign and send e-mail messages via SMTP or third party services such as Mailchimp, Mailgun, etc. It includes the following features:
- Generates e-mail messages conforming to the Internet Message Format standard (RFC 5322).
- Full MIME support (RFC 2045 - 2049) with automatic selection of the most optimal encoding for each message body part.
- DomainKeys Identified Mail (DKIM) Signatures (RFC 6376).
- SMTP support.
- Secure delivery over TLS.
- Authentication with automatic mechamism selection.
- Multiple authentication mechanisms:
- XOAUTH2
- CRAM-MD5
- DIGEST-MD5
- LOGIN
- PLAIN
- Third party e-mail delivery:
- Mailchimp
- Mailgun
- Others to follow.
- Full async (requires Tokio).
Send a message via an SMTP server that requires authentication:
// Build a simple multipart message
let message = MessageBuilder::new()
.from(("John Doe", "[email protected]"))
.to(vec![
("Jane Doe", "[email protected]"),
("James Smith", "[email protected]"),
])
.subject("Hi!")
.html_body("<h1>Hello, world!</h1>")
.text_body("Hello world!");
// Connect to an SMTP relay server over TLS and
// authenticate using the provided credentials.
SmtpClient::new("smtp.gmail.com")
.credentials("john", "p4ssw0rd")
.connect_tls()
.await
.unwrap()
.send(message)
.await
.unwrap();Sign a message with DKIM and send it via an internal SMTP relay:
// Build a simple text message with a single attachment
let message = MessageBuilder::new()
.from(("John Doe", "[email protected]"))
.to("[email protected]")
.subject("Howdy!")
.text_body("These pretzels are making me thirsty.")
.binary_attachment("image/png", "pretzels.png", [1, 2, 3, 4].as_ref());
// Set up DKIM signer
let dkim = DKIM::from_pkcs1_pem_file("./cert.pem")
.unwrap()
.domain("example.com")
.selector("2022")
.headers(["From", "To", "Subject"]) // Headers to sign
.expiration(60 * 60 * 7); // Number of seconds before this signature expires (optional)
// Connect to an SMTP relay server over TLS.
// Signs each message with the configured DKIM signer.
SmtpClient::new("smtp.example.com")
.dkim(dkim)
.connect_tls()
.await
.unwrap()
.send(message)
.await
.unwrap();Send a message via Mailchimp:
// Build a simple multipart message
let message = MessageBuilder::new()
.from(("John Doe", "[email protected]"))
.to(vec![
("Jane Doe", "[email protected]"),
("James Smith", "[email protected]"),
])
.subject("Hi!")
.html_body("<h1>Hello, world!</h1>")
.text_body("Hello world!");
// Send the message via Mailchimp
MailchimpClient::new("YOUR_API_KEY")
.send(message)
.await
.unwrap();More examples of how to build messages are available in the mail-builder crate.
Please note that this library does not support parsing e-mail messages as this functionality is provided separately by the mail-parser crate.
To run the testsuite:
$ cargo test --all-featuresor, to run the testsuite with MIRI:
$ cargo +nightly miri test --all-featuresLicensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Copyright (C) 2020-2022, Stalwart Labs Ltd.
See COPYING for the license.
