92 lines
3.0 KiB
Markdown
92 lines
3.0 KiB
Markdown
# lettre
|
|
|
|
**Lettre is a mailer library for Rust.**
|
|
|
|
|
|
[](https://coveralls.io/github/lettre/lettre?branch=master)
|
|
|
|
[](https://crates.io/crates/lettre)
|
|
[](https://docs.rs/lettre/)
|
|
[]()
|
|
[](./LICENSE)
|
|
|
|
[](https://gitter.im/lettre/lettre?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
|
[](http://isitmaintained.com/project/lettre/lettre "Average time to resolve an issue")
|
|
[](http://isitmaintained.com/project/lettre/lettre "Percentage of issues still open")
|
|
|
|
Useful links:
|
|
|
|
* [User documentation](http://lettre.at/)
|
|
* [API documentation](https://docs.rs/lettre/)
|
|
* [Changelog](https://github.com/lettre/lettre/blob/master/CHANGELOG.md)
|
|
|
|
---
|
|
|
|
## 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.36 or newer.
|
|
To use this library, add the following to your `Cargo.toml`:
|
|
|
|
```toml
|
|
[dependencies]
|
|
lettre = "0.9"
|
|
```
|
|
|
|
```rust,no_run
|
|
extern crate lettre;
|
|
|
|
use lettre::{SmtpClient, Transport, Email, 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](https://github.com/lettre/lettre/blob/master/CODE_OF_CONDUCT.md).
|
|
|
|
## License
|
|
|
|
This program is distributed under the terms of the MIT license.
|
|
|
|
See [LICENSE](./LICENSE) for details.
|