Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stalwartlabs/mail-send
E-mail delivery library for Rust with DKIM support
https://github.com/stalwartlabs/mail-send
delivery dkim email mail mime rust send smtp
Last synced: 2 days ago
JSON representation
E-mail delivery library for Rust with DKIM support
- Host: GitHub
- URL: https://github.com/stalwartlabs/mail-send
- Owner: stalwartlabs
- License: apache-2.0
- Created: 2022-05-27T07:55:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-12T20:06:59.000Z (5 months ago)
- Last Synced: 2025-01-05T15:00:41.082Z (9 days ago)
- Topics: delivery, dkim, email, mail, mime, rust, send, smtp
- Language: Rust
- Homepage: https://docs.rs/mail-send/
- Size: 119 KB
- Stars: 212
- Watchers: 8
- Forks: 21
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-rust - stalwartlabs/mail-send - send](https://crates.io/crates/mail-send)] - E-mail builder and SMTP client library with DKIM support [](https://github.com/stalwartlabs/mail-send/actions/workflows/rust.yml) (Libraries / Email)
- awesome-rust-cn - stalwartlabs/mail-send - send](https://crates.io/crates/mail-send)] (库 Libraries / 电子邮件 Email)
- awesome-rust - stalwartlabs/mail-send - send](https://crates.io/crates/mail-send)] - E-mail builder and SMTP client library with DKIM support [](https://github.com/stalwartlabs/mail-send/actions/workflows/rust.yml) (Libraries / Email)
- fucking-awesome-rust - stalwartlabs/mail-send - send](crates.io/crates/mail-send)] - E-mail builder and SMTP client library with DKIM support [](https://github.com/stalwartlabs/mail-send/actions/workflows/rust.yml) (Libraries / Email)
- fucking-awesome-rust - stalwartlabs/mail-send - send](crates.io/crates/mail-send)] - E-mail builder and SMTP client library with DKIM support [](https://github.com/stalwartlabs/mail-send/actions/workflows/rust.yml) (Libraries / Email)
README
# mail-send
[](https://crates.io/crates/mail-send)
[](https://github.com/stalwartlabs/mail-send/actions/workflows/rust.yml)
[](https://docs.rs/mail-send)
[](http://www.apache.org/licenses/LICENSE-2.0)
_mail-send_ is a Rust library to build, sign and send e-mail messages via SMTP. 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_) with ED25519-SHA256, RSA-SHA256 and RSA-SHA1 support.
- Simple Mail Transfer Protocol (**SMTP**; _RFC 5321_) delivery.
- SMTP Service Extension for Secure SMTP over **TLS** (_RFC 3207_).
- SMTP Service Extension for Authentication (_RFC 4954_) with automatic mechanism negotiation (from most secure to least secure):
- CRAM-MD5 (_RFC 2195_)
- DIGEST-MD5 (_RFC 2831_; obsolete but still supported)
- XOAUTH2 (Google proprietary)
- LOGIN
- PLAIN
- Full async (requires Tokio).
## Usage Example
Send a message via an SMTP server that requires authentication:
```rust
// 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("
Hello, world!
")
.text_body("Hello world!");
// Connect to the SMTP submissions port, upgrade to TLS and
// authenticate using the provided credentials.
SmtpClientBuilder::new("smtp.gmail.com", 587)
.implicit_tls(false)
.credentials(("john", "p4ssw0rd"))
.connect()
.await
.unwrap()
.send(message)
.await
.unwrap();
```
Sign a message with DKIM and send it via an SMTP relay server:
```rust
// 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.")
.attachment("image/png", "pretzels.png", [1, 2, 3, 4].as_ref());
// Sign an e-mail message using RSA-SHA256
let pk_rsa = RsaKey::::from_rsa_pem(TEST_KEY).unwrap();
let signer = DkimSigner::from_key(pk_rsa)
.domain("example.com")
.selector("default")
.headers(["From", "To", "Subject"])
.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.
SmtpClientBuilder::new("smtp.gmail.com", 465)
.connect()
.await
.unwrap()
.send_signed(message, &signer)
.await
.unwrap();
```
More examples of how to build messages are available in the [`mail-builder`](https://crates.io/crates/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`](https://crates.io/crates/mail-parser) crate.
## Testing
To run the testsuite:
```bash
$ cargo test --all-features
```
or, to run the testsuite with MIRI:
```bash
$ cargo +nightly miri test --all-features
```
## License
Licensed under either of
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## Copyright
Copyright (C) 2020-2022, Stalwart Labs Ltd.