Nemo's notes on making mutt work for newsgroups, via some helper utilities that talk nntp, and scripts which bind them together.
slrnpull pulls messages into it's own spool. This spool is readable with mutt directly (best method for that is: create a Maildir, but make 'new' be a symlink to the newsgroup spool. The filenames dont start out in Maildir recommended format, but they are happily read. And when they're written out to 'cur' they get flagged appropriately and everything is happy.
Alternatively, I want to keep my newsspool "pure" (as a backup/archive), so I copy them over with newsspool2Maildir...
newsspool2Maildir simply reads a news spool (so it's an extremely simple news client?), and caches what it reads to a Maildir (so, it's an MDA)
It operates by
- discovering locally "subscribed" newsgroups. (for me, they are all Maildir folders matching the path "~/Maildir/.nntp.*" - where the trailing wildcard is the group name)
- for each group, find new messages from the equivalent slrnpull spool, and copying them over to the Maildir as new messages. (See Maildir for notes on the filenames I give it ;)
Messages can now be read, flagged, deleted, etc, as normal in mutt (or within any other mail client of choice that can read the Maildir, either directly or via IMAP/etc)
It operates in a read-only fashion on the spool, and keeps state of where it read up to for each group via a state file within the group's Maildir. Flushing the spool is outside the scope of this utility and should be handled by slrnpull
We can also check if slrnpull's conf file matches the groups subscribed to within the Maildir and alert to logs if they differ.
- Future functionality may write the slrnpull conf file to match also!
Compose new messages in mutt as normal, but we divert them from the normal bin/sendmail path to smtp, and instead redirect (and reformat as needed) them into the slrnpull outgoing queue.
This is done by setting the $sendmail variable within mutt - to a custom script, and is active only when reading .nntp.* Maildirs (thanks, folder-hook)
Editing in mutt
I wrote a test email in mutt, adding a newsgroup: header, and then saved a local copy of the message as seen in the mutt editor (vim) before saving a local copy, and also setting $sendmail to a script which would save that copy too!
From: Nemo Thorx <nemo@house> To: firstname.lastname@example.org Cc: Bcc: Subject: test Reply-To: Organization: Thorx Enterprises Newsgroups: alt.test test .test1 ..test2 . ...test3 -- ------------------------------------------ -------------------------- earth native
note that I had to fill in To: field ... mutt wont let it send without that filled in! (it will let it go with as minimal as 'xxx@' - but if I try just 'xxx', then mutt auto-fills the domain. The custom headers (including 'newsgroups' are not visible in the mail summary screen, but are not lost.
local saved copy:
Date: Thu, 27 Oct 2011 23:09:05 +1000 From: Nemo Thorx <nemo@house> To: email@example.com Subject: test Message-ID: <20111027130905.GB24456@nemo.house> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Organization: Thorx Enterprises Newsgroups: alt.test User-Agent: Mutt/1.5.20 (2009-06-14) Status: RO test .test1 ..test2 . ...test3 -- ------------------------------------------ -------------------------- earth native
notice the empty headers removed and new headers added in
copy sent to "sendmail" was the same as the local copy, but without the 'Status' header.
So, to make the "sendmail" copy friendly for newsgroups - we need to delete the mail specific headers, pad the leading .lines, and save into the slrn out.going spool.
thoughts: could the To: header be renamed on the fly to Newsgroups? (but what about the requirement in mutt that To: include email addresses? Two options?
- the To: field is ignored - ie, any address is ignored
- user-munged newsgroup names. eg
- firstname.lastname@example.org, alt@test,
- alt.fan.douglas-adams@nntp ...this is probably my favourite, since mutt will auto-append the domain to a the group name when entered into To:, and the domain can be easily thrown away again by sendmail2newspool :)
Note also that mutt WILL allow sending without a subject, whilst that will fail to nntp (which appears to require at minimum a "Subject: " header)
Mutt will <r>eply (or <g>roup reply) to the author's email address. I can set a folder-hook which sets a "my_hdr to" to add an additional address as a reminder, but the 'to' field does ultimately have to be manually set!
I'm not sure if this is possible without getting convoluted. (detect a non-group email address and pipe the message through to sendmail?)
Minimum post requirement for slrnpull
A post in the var/spool/slrnpull/out.going/ directory needs to be only named "X", and can get away with only From:, Newsgroups: and Subject: headers, along with a body. Upstream servers will fill out the remainder.
The file needs to be protocol encoded - that is, any lines with a leading "." needs that . to be doubled.
For eg, a file named 'X' with these contents
From: Nobody <devnull@home> Newsgroups: alt.test Subject: test 2 test .testone ..testtwo ...testthree . test after a terminating .
returns from the same server, in the same slrnpull loop as when it was posted, as:
Path: news.astraweb.com!news-xref3.astraweb.com!not-for-mail From: Nobody <devnull@home> Newsgroups: alt.test Subject: test 2 Date: 27 Oct 2011 12:17:36 GMT Lines: 4 Message-ID: <email@example.com> Organization: Unlimited download news at news.astraweb.com NNTP-Posting-Host: a82854f6.news.astraweb.com X-Trace: DXC=m2DM4:=`Ee2o^d=IeQT`3>L?0kYOcDh@:[^oANOZPWM0m8]Ha;Fb[[:l9B_G1R=S=7YoIj:2_Q5X<fQ:A^;C6QQ0\M[9B[:?8U: Xref: news.astraweb.com alt.test:2319994 test testone .testtwo ..testthree
Note that the '.' on a line itself ended the post!
The headers provided by slrn in a post are:
Newsgroups: From: Subject: Reply-To: Followup-To: Keywords: Summary:
whilst if posted with minimal additions (ie, Newsgroups:, From: and Subject: only are set), then the following headers are posted (content removed except for User Agent: and Message-ID:)
Newsgroups: From: Subject: User-Agent: slrn/pre1.0.0-18 (Linux) Message-ID: <firstname.lastname@example.org>
common headers that the user (or MUA) has control over...
mail-only headers (will need removing)
- Date - auto generated
- Message-ID - auto generated
- User-Agent - auto generated
- References - (mutt does not generate this one, though it reads it)
news-only headers (needs adding or converting)
Headers that appear in every news message
(analysis from one group - 3000 messages over 3 years)
Date From Message-ID Newsgroups Path Subject Xref
My ideas so far
- Analyse To/Cc/Bcc for email addresses and if they exist, then send a copy of the message to sendmail (with newsgroups removed from these headers)
- Coalesce all newsgroups from the To/Cc/Bcc headers into a single Newsgroups header.
- note: how to distinguish between newsgroup fake email addresses, and real email addresses??
- Should there be any newsgroups in the 'Reply-To' header, move those into 'Followup-To' header. Leave email addresses in this header intact (assuming this is RFC-OK)
- possibly munge the message-ID header for the sake of script vanity?
- prepend . to any .lines in the message
- save file to a valid unique name within slrnpull out.going directory
- sendmail2newspool triggers the slrnpull post (normally otherwise handled by cron?) and if the posting fails, grabs the message out of the reject folder, and moves it into a bounce Maildir of some kind for the user to see
- pro: instant
- con: this sort of thing is news2Maildir's job
- also: dunno if this will work with a system spool
- news2Maildir checks the reject folder along with it's other checks.
- pro: this is exactly the point of news2Maildir
- con: not exactly timely, since this is a cron thing.
Best of both worlds: sendmail2newspool triggers news2Maildir at the end of it's posting, and so we satisfy both efficiency of code, and promptness of seeing the post either immediately accepted or bounced :)
- to check: what happens when there are multiple slrnpull instances running simultaneously?
This could be used against leafnode without too much difficulty, but leafnode provides a local nntp server - implying the use of a local nntp client. And the whole point of this exercise is to not in fact need that!
- newsspool2Maildir needs some directories changing, and that's about it, I think! The stored files (including magic .overview) otherwise work the same.
- mutt2newsspool - needs to write to leafnode's out.going directory, and set it chmod u+r (0400). Failed postings are in failed.postings.
- for more info: http://leafnode.sourceforge.net/doc_en/fetchnews.8.html
- Even with "allow_8bit_headers" set, some articles are not be downloaded at all!
- they're pedantically not compliant articles, but slrn gets them. Clearly upstream gets them and was happy with them. Google groups has also been confirmed to be ok with them... leafnode ends up with an empty file in it's message.id tree - allowing me to know it's message ID, but nothing more! :(
- If an article has a header but no body, nothing is kept (slrnpull keeps the header at least - which allows for the Message-ID to be searched (say, in google groups) and the message body possibly recovered :)
- the leafnode method of knowing which groups are 'interesting' would be easier to sync than the slrnpull config file method
- See also Maildir on this wiki