From 04f064ed5a347f01cafcf1334335f2d882cd9a21 Mon Sep 17 00:00:00 2001 From: RotationMatrix <52428419+RotationMatrix@users.noreply.github.com> Date: Fri, 23 Oct 2020 07:31:03 -0400 Subject: [PATCH] Add README for examples (#489) * Add README for examples * Fix typo in examples/README.md Co-authored-by: Paolo Barbolini * 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 * Fix typo in examples/README.md Co-authored-by: Paolo Barbolini --- examples/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 examples/README.md diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..18462b3 --- /dev/null +++ b/examples/README.md @@ -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