add a --dev mode

1 files changed, 38 insertions, 0 deletions

diff --git a/tests/instrumentation/README.md b/tests/instrumentation/README.md
new file mode 100644
index 0000000..b479cf4
--- /dev/null
+++ b/tests/instrumentation/README.md
@@ -0,0 +1,38 @@
+# Spawn Dovecot+Maddy+Cyrus
+
+Run:
+
+```
+docker-compose up
+```
+
+  - Dovecot
+    - listen on :993, run `openssl s_client -connect 127.0.0.1:993`
+    - login with `A LOGIN test pass`
+  - Maddy
+    - listen on :994,  run `openssl s_client -connect 127.0.0.1:994`
+    - login with `A LOGIN test@example.com pass`
+  - Cyrus
+    - listen on :143, run `nc 127.0.0.1 143`
+    - login with `A LOGIN test pass`
+  - Stalwart
+    - listen on :1993, run `openssl s_client -connect 127.0.0.1:993`
+    - login with `A LOGIN test@example.com pass`
+    - note: not packaged in docker yet...
+
+Other IMAP servers we could add:
+  - WildDuck (own node.js imap implementation)
+    - https://github.com/nodemailer/wildduck
+  - DBMail (own C IMAP implementation)
+    - https://github.com/dbmail/dbmail/tree/master
+  - UW IMAP (known to be the reference IMAP implementation)
+    - https://wiki.archlinux.org/title/UW_IMAP
+  - Apache James (has its own implementation of IMAP too)
+    - https://james.apache.org/
+  - Citadel
+    - https://citadel.org
+    - https://code.citadel.org/?p=citadel;a=tree;f=citadel/server/modules/imap;h=3ceaa1d6b518bddb7539911a8dd9d81136d4e594;hb=HEAD
+
+# Inject emails and dump the computed `BODY` + `BODYSTRUCTURE`
+
+Once you ran `docker-compose up`, launch `./send-to-imap.py`