From 768227f7aa31e2930e1ff2641c24fbf06fc339fe Mon Sep 17 00:00:00 2001 From: Ruben Beltran del Rio Date: Sat, 25 Jan 2025 10:50:26 +0100 Subject: Add 1.0.0 --- man/olden-mail.1 | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 man/olden-mail.1 (limited to 'man') diff --git a/man/olden-mail.1 b/man/olden-mail.1 new file mode 100644 index 0000000..e72a08e --- /dev/null +++ b/man/olden-mail.1 @@ -0,0 +1,44 @@ +.TH OLDEN-MAIL 1 "2025-01-25" "1.0.0" "Olden Mail Manual" +.SH NAME +olden-mail \- IMAP & SMTP proxy to connect vintage clients to modern e-mail. +.SH SYNOPSIS +.B olden-mail +.SH DESCRIPTION +.PP +`olden-mail` is an IMAP & SMTP proxy that allows you to connect to SSL +enabled mail servers using insecure plaintext connections in computers that +don't support SSL or have older ciphers. +.SH ENVIRONMENT VARIABLES +You can configure the proxy through environment variables. +.TP +.B LOCAL_IMAP_PORT +The port on which to listen for IMAP clients. Defaults to 143. +.TP +.B LOCAL_IMAP_BIND_ADDRESS +The address on which to listen for IMAP clients. Defaults to 0.0.0.0. +.TP +.B REMOTE_IMAP_PORT +The TLS enabled remote port to which we will proxy the connection. Defaults to +993. +.TP +.B REMOTE_IMAP_HOST +The remote host to which we will proxy the connection. Required. +.TP +.B LOCAL_SMTP_PORT +The port on which to listen for SMTP clients. Defaults to 25. +.TP +.B LOCAL_SMTP_BIND_ADDRESS +The address on which to listen for SMTP clients. Defaults to 0.0.0.0. +.TP +.B REMOTE_SMTP_PORT +The TLS enabled remote port to which we will proxy the connection. Defaults to +465. +.TP +.B REMOTE_SMTP_HOST +The remote host to which we will proxy the connection. Required. +.SH VERSION +.BR 1.0.0 +.SH HOMEPAGE +.I https://r.bdr.sh/olden-mail.html +.SH AUTHORS +\ Rubén Beltrán del Río <\fIolden.mail@r.bdr.sh\fP> -- cgit