crabmail

Static HTML email archive viewer in Rust
git clone git://git.alexwennerberg.com/crabmail
Log | Files | Refs | README | LICENSE

commit b8ef12a178784af9eb946aeafe146ab35afe3e80
parent 0dfc8c3490a0f8de1d349a8c7ff4bded7781fc0a
Author: alex wennerberg <alex@alexwennerberg.com>
Date:   Sun,  3 Apr 2022 16:50:46 -0700

update docs, readme

Diffstat:
MREADME.md | 6++----
Mdoc/crabmail-config.5 | 11++---------
Mdoc/crabmail-config.5.scd | 7+------
Mdoc/crabmail.1 | 12+++++-------
Mdoc/crabmail.1.scd | 10++++------
Msrc/config.rs | 6++----
6 files changed, 16 insertions(+), 36 deletions(-)

diff --git a/README.md b/README.md @@ -1,8 +1,5 @@ # 🦀Crabmail🦀 -THIS IS CURRENTLY IN A REWRITE. IF YOU WANT TO USE IT, WAIT A BIT, OR DIG -THROUGH COMMIT HISTORY - [self-hosted](https://git.alexwennerberg.com/crabmail/) / [github mirror](https://github.com/alexwennerberg/crabmail) A static mail HTML and [Gemini](https://gemini.circumlunar.space/) archive for @@ -19,7 +16,8 @@ Not implemented yet / designed: EMAIL FOREVER! -[lists.flounder.online demo](https://lists.flounder.online) +* [lists.flounder.online demo](https://lists.flounder.online) +* [On gemini!](gemini://lists.flounder.online) ## Installation and usage diff --git a/doc/crabmail-config.5 b/doc/crabmail-config.5 @@ -5,7 +5,7 @@ .nh .ad l .\" Begin generated content: -.TH "crabmail-config" "5" "2022-01-21" +.TH "crabmail-config" "5" "2022-04-03" .P .SH NAME .P @@ -51,13 +51,6 @@ A description for your homepage, will be displayed as a single line.\& HTML is allowed if you want.\& .P .RE -\fBreply_add_link\fR -.RS 4 -Add a link to the thread in the "reply to" url.\& This allows users to see the -thread context when receiving responses via email.\& TBD: This will allow poorly designed -clients (eg Gmail) to still be threaded properly.\& Default: false -.P -.RE .SS Archives .P Each mail archive is specified with a [subsection] header.\& @@ -82,4 +75,4 @@ A description for your archive.\& HTML is allowed, but be judicious.\& \fBcrabmail\fR(1) .P .SH AUTHORS -Alex Wennerberg <alex@alexwennerberg.\&com +Alex Wennerberg <alex@alexwennerberg.\&com> diff --git a/doc/crabmail-config.5.scd b/doc/crabmail-config.5.scd @@ -36,11 +36,6 @@ don't fill in values from user input somehow). A description for your homepage, will be displayed as a single line. HTML is allowed if you want. -*reply_add_link* - Add a link to the thread in the "reply to" url. This allows users to see the - thread context when receiving responses via email. TBD: This will allow poorly designed - clients (eg Gmail) to still be threaded properly. Default: false - ## Archives Each mail archive is specified with a [subsection] header. @@ -59,4 +54,4 @@ Each mail archive is specified with a [subsection] header. *crabmail*(1) # AUTHORS -Alex Wennerberg <alex@alexwennerberg.com +Alex Wennerberg <alex@alexwennerberg.com> diff --git a/doc/crabmail.1 b/doc/crabmail.1 @@ -5,7 +5,7 @@ .nh .ad l .\" Begin generated content: -.TH "crabmail" "1" "2022-01-13" +.TH "crabmail" "1" "2022-04-03" .P .SH NAME .P @@ -19,16 +19,14 @@ crabmail [-rR] [-c CONFIG] [-d OUT_DIR] maildir .P Crabmail writes html pages for the maildir folders contained within \fBmaildir\fR .P -\fB-r\fR +\fB-g\fR .RS 4 -Use relative timestamps ("2 hours ago") instead of absolute ones.\& This makes -your archive more readable, but only if the index is being updated frequently +include gemini output.\& default true if neither this nor \fB-h\fR is present.\& .P .RE -\fB-R\fR +\fB-h\fR .RS 4 -ALPHA Include a link to the raw email message, with many headers stripped.\& -Has several open issues at the moment.\& +include html output.\& default true if neither this nor \fB-h\fR is present.\& .P .RE \fB-c CONFIG\fR diff --git a/doc/crabmail.1.scd b/doc/crabmail.1.scd @@ -12,13 +12,11 @@ crabmail [-rR] [-c CONFIG] [-d OUT_DIR] maildir Crabmail writes html pages for the maildir folders contained within *maildir* -*-r* - Use relative timestamps ("2 hours ago") instead of absolute ones. This makes - your archive more readable, but only if the index is being updated frequently +*-g* + include gemini output. default true if neither this nor *-h* is present. -*-R* - ALPHA Include a link to the raw email message, with many headers stripped. - Has several open issues at the moment. +*-h* + include html output. default true if neither this nor *-h* is present. *-c CONFIG* diff --git a/src/config.rs b/src/config.rs @@ -29,9 +29,8 @@ pub struct Config { pub description: String, pub include_gemini: bool, pub include_html: bool, - pub out_dir: PathBuf, // TODO rem - pub now: String, // TODO rem - pub reply_add_link: bool, // Might remove this + pub out_dir: PathBuf, // TODO rem + pub now: String, // TODO rem pub subsections: Vec<Subsection>, } @@ -43,7 +42,6 @@ impl Config { "title_fmt" => self.title_fmt = value.to_string(), "base_url" => self.base_url = value.to_string(), "description" => self.description = value.to_string(), - "reply_add_link" => self.reply_add_link = value == "true", _ => {} } }