aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorQuentin Dufour <quentin@deuxfleurs.fr>2022-08-01 10:50:21 +0200
committerQuentin Dufour <quentin@deuxfleurs.fr>2022-08-01 10:50:21 +0200
commit7022d12e82efe6daec5543c5e60a314161ed32ad (patch)
treeb4fa4911f039f8e49af36cbf69dbdc0b7c6dd46c
parent112e63b5d7feb9476b6bd1852dc276bb3de2d0bd (diff)
downloadaerogramme-7022d12e82efe6daec5543c5e60a314161ed32ad.tar.gz
aerogramme-7022d12e82efe6daec5543c5e60a314161ed32ad.zip
Add an IMAP trace in the doc
-rw-r--r--doc/src/validate.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/src/validate.md b/doc/src/validate.md
index ed7dfa7..9f4f6ec 100644
--- a/doc/src/validate.md
+++ b/doc/src/validate.md
@@ -6,4 +6,43 @@ Start a server as follow:
cargo run -- server
```
+Now you can use netcat to connect on the LMTP and IMAP endpoint to check that Aerogramme behaves as expected. As an example, here is an IMAP trace extracted from Aerogramme:
+```
+S: * OK Hello
+C: A1 LOGIN lx plop
+S: A1 OK Completed
+C: A2 SELECT INBOX
+S: * 0 EXISTS
+S: * 0 RECENT
+S: * FLAGS (\Seen \Answered \Flagged \Deleted \Draft)
+S: * OK [PERMANENTFLAGS (\Seen \Answered \Flagged \Deleted \Draft \*)] Flags permitted
+S: * OK [UIDVALIDITY 1] UIDs valid
+S: * OK [UIDNEXT 1] Predict next UID
+S: A2 OK [READ-WRITE] Select completed
+C: A3 NOOP
+S: A3 OK NOOP completed.
+ <---- e-mail arrives through LMTP server ---->
+C: A4 NOOP
+S: * 1 EXISTS
+S: A4 OK NOOP completed.
+C: A5 FETCH 1 FULL
+S: * 1 FETCH (UID 1 FLAGS () INTERNALDATE "06-Jul-2022 14:46:42 +0000"
+ RFC822.SIZE 117 ENVELOPE (NIL "test" (("Alan Smith" NIL "alan" "smith.me"))
+ NIL NIL (("Alan Smith" NIL "alan" "aerogramme.tld")) NIL NIL NIL NIL)
+ BODY ("TEXT" "test" NIL "test" "test" "test" 1 1))
+S: A5 OK FETCH completed
+C: A6 FETCH 1 (RFC822)
+S: * 1 FETCH (UID 1 RFC822 {117}
+S: Subject: test
+S: From: Alan Smith <alan@smith.me>
+S: To: Alan Smith <alan@aerogramme.tld>
+S:
+S: Hello, world!
+S: .
+S: )
+S: A6 OK FETCH completed
+C: A7 LOGOUT
+S: * BYE Logging out
+S: A7 OK Logout completed
+```