rust/lettre
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: document OpenSSL system dependencies (#1030)

Browse Source
This commit is contained in:
Paolo Barbolini
2025-02-01 22:14:14 +01:00
committed by GitHub
parent 4513e602d6
commit 5f13636b49
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/lib.rs
View File

@@ -34,13 +34,25 @@
//! //!
//! _Secure SMTP connections using TLS from the `native-tls` crate_ //! _Secure SMTP connections using TLS from the `native-tls` crate_
//! //!
//! Uses schannel on Windows, Security-Framework on macOS, and OpenSSL on Linux. //! Uses schannel on Windows, Security-Framework on macOS, and OpenSSL
//! on all other platforms.
//! //!
//! * **native-tls** 📫: TLS support for the synchronous version of the API //! * **native-tls** 📫: TLS support for the synchronous version of the API
//! * **tokio1-native-tls**: TLS support for the `tokio1` async version of the API //! * **tokio1-native-tls**: TLS support for the `tokio1` async version of the API
//! //!
//! NOTE: native-tls isn't supported with `async-std` //! NOTE: native-tls isn't supported with `async-std`
//! //!
//! ##### Building lettre with OpenSSL
//!
//! When building lettre with native-tls on a system that makes
//! use of OpenSSL, the following packages will need to be installed
//! in order for the build and the compiled program to run properly.
//!
//! | Distro | Build-time packages | Runtime packages |
//! | ------------ | -------------------------- | ---------------------------- |
//! | Debian | `pkg-config`, `libssl-dev` | `libssl3`, `ca-certificates` |
//! | Alpine Linux | `pkgconf`, `openssl-dev` | `libssl3`, `ca-certificates` |
//!
//! #### SMTP over TLS via the boring crate (Boring TLS) //! #### SMTP over TLS via the boring crate (Boring TLS)
//! //!
//! _Secure SMTP connections using TLS from the `boring-tls` crate_ //! _Secure SMTP connections using TLS from the `boring-tls` crate_