aboutsummaryrefslogtreecommitdiff
path: root/doc/src/validate.md
diff options
context:
space:
mode:
authorQuentin Dufour <quentin@deuxfleurs.fr>2022-08-03 16:00:44 +0200
committerQuentin Dufour <quentin@deuxfleurs.fr>2022-08-03 16:00:44 +0200
commit0e45eb9a6953b02d422f9d2144c8229962ac0b40 (patch)
treed36ef9398c191ea1015c51622ad7a100be0dc734 /doc/src/validate.md
parent5015b98db8bd231f2facc5692b881f78194af8e9 (diff)
downloadaerogramme-0e45eb9a6953b02d422f9d2144c8229962ac0b40.tar.gz
aerogramme-0e45eb9a6953b02d422f9d2144c8229962ac0b40.zip
Update documentation
Diffstat (limited to 'doc/src/validate.md')
-rw-r--r--doc/src/validate.md66
1 files changed, 29 insertions, 37 deletions
diff --git a/doc/src/validate.md b/doc/src/validate.md
index 9f4f6ec..57903f6 100644
--- a/doc/src/validate.md
+++ b/doc/src/validate.md
@@ -6,43 +6,35 @@ 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:
+Inject emails:
+```bash
+./test/inject_emails.sh '<me@aerogramme.tld>' dxflrs
```
-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
+
+Now you can connect your mailbox with `mutt`.
+Start by creating a config file, for example we used the following `~/.muttrc` file:
+
+```ini
+set imap_user = quentin
+set imap_pass = p455w0rd
+set folder = imap://localhost:1993
+set spoolfile = +INBOX
+set ssl_starttls = no
+set ssl_force_tls = no
+mailboxes = +INBOX
+bind index G imap-fetch-mail
```
+
+And then simply launch `mutt`.
+The first time nothing will happen as Aerogramme must
+process your incoming emails. Just ask `mutt` to refresh its
+view by pressing `G` (for *Get*).
+
+Now, you should see some emails:
+
+![Screenshot of mutt mailbox](./mutt_mb.png)
+
+And you can read them:
+
+![Screenshot of mutt mail view](./mutt_mail.png)