Add README for examples (#489)
* Add README for examples * Fix typo in examples/README.md Co-authored-by: Paolo Barbolini <paolo@paolo565.org> * Update examples/README.md Add links to source files and improve wording. * Fix typos in examples/README.md * Update examples/README.md Fix typo. Add line under title. Co-authored-by: Paolo Barbolini <paolo@paolo565.org> * Fix typo in examples/README.md Co-authored-by: Paolo Barbolini <paolo@paolo565.org>
This commit is contained in:
16
examples/README.md
Normal file
16
examples/README.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Lettre Examples
|
||||
|
||||
This folder contains examples showing how to use lettre in your own projects.
|
||||
|
||||
## Examples
|
||||
- [smtp.rs] - Send an email using a local SMTP daemon on port 25 as a relay.
|
||||
- [smtp_tls.rs] - Send an email over SMTP encrypted with TLS and authenticating with username and password.
|
||||
- [smtp_starttls.rs] - Send an email over SMTP with STARTTLS and authenticating with username and password.
|
||||
- [smtp_selfsigned.rs] - Send an email over SMTP encrypted with TLS using a self-signed certificate and authenticating with username and password.
|
||||
- The [smtp_tls.rs] and [smtp_starttls.rs] examples also feature `async`hronous implementations powered by [Tokio](https://tokio.rs/).
|
||||
These files are prefixed with `tokio02_` or `tokio03_`.
|
||||
|
||||
[smtp.rs]: ./smtp.rs
|
||||
[smtp_tls.rs]: ./smtp_tls.rs
|
||||
[smtp_starttls.rs]: ./smtp_starttls.rs
|
||||
[smtp_selfsigned.rs]: ./smtp_selfsigned.rs
|
||||
Reference in New Issue
Block a user