git.r.bdr.sh - rbdr/olden-mail/blob - man/olden-mail.1

   1 .TH OLDEN-MAIL 1 "2025-01-25" "1.0.0" "Olden Mail Manual"
   2 .SH NAME
   3 olden-mail \- IMAP & SMTP proxy to connect vintage clients to modern e-mail.
   4 .SH SYNOPSIS
   5 .B olden-mail
   6 .SH DESCRIPTION
   7 .PP
   8 `olden-mail` is an IMAP & SMTP proxy that allows you to connect to SSL
   9 enabled mail servers using insecure plaintext connections in computers that
  10 don't support SSL or have older ciphers.
  11 .SH ENVIRONMENT VARIABLES
  12 You can configure the proxy through environment variables.
  13 .TP
  14 .B LOCAL_IMAP_PORT
  15 The port on which to listen for IMAP clients. Defaults to 143.
  16 .TP
  17 .B LOCAL_IMAP_BIND_ADDRESS
  18 The address on which to listen for IMAP clients. Defaults to 0.0.0.0.
  19 .TP
  20 .B REMOTE_IMAP_PORT
  21 The TLS enabled remote port to which we will proxy the connection. Defaults to
  22 993.
  23 .TP
  24 .B REMOTE_IMAP_HOST
  25 The remote host to which we will proxy the connection. Required.
  26 .TP
  27 .B LOCAL_SMTP_PORT
  28 The port on which to listen for SMTP clients. Defaults to 25.
  29 .TP
  30 .B LOCAL_SMTP_BIND_ADDRESS
  31 The address on which to listen for SMTP clients. Defaults to 0.0.0.0.
  32 .TP
  33 .B REMOTE_SMTP_PORT
  34 The TLS enabled remote port to which we will proxy the connection. Defaults to
  35 465.
  36 .TP
  37 .B REMOTE_SMTP_HOST
  38 The remote host to which we will proxy the connection. Required.
  39 .SH VERSION
  40 .BR 1.0.0
  41 .SH HOMEPAGE
  42 .I https://r.bdr.sh/olden-mail.html
  43 .SH AUTHORS
  44 \ Rubén Beltrán del Río <\fIolden.mail@r.bdr.sh\fP>