Update music

[rbdr/r.bdr.sh] / olden-mail.gmi

diff --git a/olden-mail.gmi b/olden-mail.gmi
index 924a2c169375892fa766a3becd482305ca5b8424..77fd6408ee3bfdc1ec0735c57360067f06cbe000 100644 (file)
--- a/olden-mail.gmi
+++ b/olden-mail.gmi
@@ -2,12 +2,9 @@
 --- description: IMAP & SMTP proxy to connect vintage clients to modern e-mail.
 ## Olden Mail
 
 --- description: IMAP & SMTP proxy to connect vintage clients to modern e-mail.
 ## Olden Mail
 

-olden-mail is an IMAP & SMTP proxy that allows you to connect to SSL
-enabled mail servers using insecure plaintext connections.
+olden-mail is an IMAP & SMTP proxy that allows you to connect to SSL enabled mail servers using insecure plaintext connections.

 
 

-This is of course very insecure, but it's intended to allow vintage
-computers that don't have SSL capability or ther right ciphers to still
-be used for e-mail.
+This is of course very insecure, but it's intended to allow vintage computers that don't have SSL capability or ther right ciphers to still be used for e-mail.

 
 => https://git.r.bdr.sh/rbdr/olden-mail ⧇ source
 => https://git.sr.ht/~rbdr/olden-mail ⧉ mirror
 
 => https://git.r.bdr.sh/rbdr/olden-mail ⧇ source
 => https://git.sr.ht/~rbdr/olden-mail ⧉ mirror


@@ -23,14 +20,11 @@ You can install using homebrew.
 ```
 
 ### Prebuilt Packages
 ```
 
 ### Prebuilt Packages

-You can find pre-built packages for linux @ build.r.bdr.sh. There you can
-find a `.tar.gz` that includes only the binary, or `.rpm` and `.deb`
-distributions for fedora and debian that include a manpage.
+You can find pre-built packages for linux @ build.r.bdr.sh. There you can find a `.tar.gz` that includes only the binary, or `.rpm` and `.deb` distributions for fedora and debian that include a manpage.

 
 Binaries are provided for x86_64 and aarch64.
 
 
 Binaries are provided for x86_64 and aarch64.
 

-Unstable releases are built directly from the main branch, while tagged
-versions have their own release and can be considered more stable.
+Unstable releases are built directly from the main branch, while tagged versions have their own release and can be considered more stable.

 
 => gemini://build.r.bdr.sh/olden-mail olden-mail pre-built releases @ gemini
 => https://build.r.bdr.sh/olden-mail olden-mail pre-built releases @ https
 
 => gemini://build.r.bdr.sh/olden-mail olden-mail pre-built releases @ gemini
 => https://build.r.bdr.sh/olden-mail olden-mail pre-built releases @ https


@@ -53,24 +47,26 @@ Then copy the file somewhere in your PATH
 The proxy requires you to set environment variables, but otherwise takes
 no options.
 
 The proxy requires you to set environment variables, but otherwise takes
 no options.
 

-* `LOCAL_IMAP_PORT` u16, the port in which the server will listen for
-  IMAP clients. Defaults to 143.
-* `LOCAL_IMAP_BIND_ADDRESS` String, the address on which to listen for
-  IMAP clients. Defaults to 0.0.0.0.
-* `REMOTE_IMAP_PORT` u16, the port to which the server will forward the
-  IMAP messages. Defaults to 993.
-* `REMOTE_IMAP_HOST` String, the host to which the server will forward the
-  IMAP messages. Required.
-
-* `LOCAL_SMTP_PORT` u16, the port in which the server will listen for
-  SMTP clients. Defaults to 25.
-* `LOCAL_SMTP_BIND_ADDRESS` String, the address on which to listen for
-  SMTP clients. Defaults to 0.0.0.0.
-* `REMOTE_SMTP_PORT` u16, the port to which the server will forward the
-  SMTP messages. Defaults to 465.
-* `REMOTE_SMTP_HOST` String, the host to which the server will forward the
-  SMTP messages. Required.
+* `LOCAL_IMAP_PORT` u16, the port in which the server will listen for IMAP clients. Defaults to 143.
+* `LOCAL_IMAP_BIND_ADDRESS` String, the address on which to listen for IMAP clients. Defaults to 0.0.0.0.
+* `REMOTE_IMAP_PORT` u16, the port to which the server will forward the IMAP messages. Defaults to 993.
+* `REMOTE_IMAP_HOST` String, the host to which the server will forward the IMAP messages. Required.
+
+* `LOCAL_SMTP_PORT` u16, the port in which the server will listen for SMTP clients. Defaults to 25.
+* `LOCAL_SMTP_BIND_ADDRESS` String, the address on which to listen for SMTP clients. Defaults to 0.0.0.0.
+* `REMOTE_SMTP_PORT` u16, the port to which the server will forward the SMTP messages. Defaults to 465.
+* `REMOTE_SMTP_HOST` String, the host to which the server will for SMTP messages. Required.
+
+## Middleware
+
+Olden mail comes with middleware that transforms messages before they're sent to the client or server:
+
+- Converts IMAPv3 FIND MAILBOX commands to IMAPv4 LIST commands.
+
+Whenever a command is modified you can see the actual sent text prefixed with `###` in the debug logs.

 
 ## Changelog
 
 
 ## Changelog
 

+* 1.1.0 Adds middleware to support IMAPv3 FIND MAILBOX
+* 1.0.1 Removes noisy debug statements

 * 1.0.0 Initial Release
 * 1.0.0 Initial Release