From 287b40984b2b7fd7fb18f157c0743eb15b84a295 Mon Sep 17 00:00:00 2001 From: purarue <7804791+purarue@users.noreply.github.com> Date: Wed, 27 Nov 2024 11:48:50 -0800 Subject: [PATCH] doc: misc updates to grammar --- README.md | 2 +- doc/MAIL_SETUP.md | 8 ++------ 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 506ffe0..e5107e5 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ It's a Python library (named `my`), a collection of modules for: [_Why?_](https://github.com/karlicoss/HPI#why) -This is built on top of [`karlicoss/HPI`](https://github.com/karlicoss/HPI). It started out as a fork, but has since been converted to my own set of modules. This is installed alongside the upstream repository (meaning _you can use both modules from upstream and here simultaneously_), see [#install](#install) +This is built on top of [`karlicoss/HPI`](https://github.com/karlicoss/HPI). These are all additional modules which aren't present in that repository - this is installed alongside the upstream repository (meaning _you can use both modules from upstream and here simultaneously_), see [#install](#install) ### My Modules diff --git a/doc/MAIL_SETUP.md b/doc/MAIL_SETUP.md index 2c0e026..e890ee0 100644 --- a/doc/MAIL_SETUP.md +++ b/doc/MAIL_SETUP.md @@ -10,9 +10,9 @@ Note: There are _lots of_ different ways email clients/websites will export mess ## `my.mail.imap` -Personally, I use `my.mail.imap`. To sync my mail, I use [`mutt-wizard`](https://github.com/LukeSmithxyz/mutt-wizard/), which uses `mbsync` under the hood to saves a bunch of individual mail files in `~/.local/share/mail` -- updating every 5 minutes. As a visual comparison to any files you may be trying to parse, [this is what one of those files looks like](https://gist.github.com/purarue/5a629efacd72e7c28de0930f7e3ed8cf) +Personally, I use `my.mail.imap`. To sync my mail, I use [`mutt-wizard`](https://github.com/LukeSmithxyz/mutt-wizard/), which uses `mbsync` under the hood to saves a bunch of individual mail files in `~/.local/share/mail` -- updating every 5 minutes. -There are, of course, hundreds of ways to save your mail locally. Lets take [the ImportTools thunderbird add-on](https://addons.thunderbird.net/en-US/thunderbird/addon/importexporttools-ng/) as an example (since its the one we did troubleshooting on in the [issue](https://github.com/purarue/HPI/issues/15)). To match the format `my.mail.imap` expects, select the folder you want to export, then use `Tools > ImportExportToolsNg > Export all messages in the Folder > Plain Text Format`, and export it to a folder somewhere. Then, in your config file, setup the block to point it at that path: +There are - of course - hundreds of ways to save your mail locally. Lets take [the ImportTools thunderbird add-on](https://addons.thunderbird.net/en-US/thunderbird/addon/importexporttools-ng/) as an example (since its the one we did troubleshooting on in the [issue](https://github.com/purarue/HPI/issues/15)). To match the format `my.mail.imap` expects, select the folder you want to export, then use `Tools > ImportExportToolsNg > Export all messages in the Folder > Plain Text Format`, and export it to a folder somewhere. Then, in your config file, setup the block to point it at that path: ```python class mail: @@ -86,7 +86,3 @@ hpi --debug query my.mail.all --stream hpi --debug query my.mail.imap --stream hpi --debug query my.mail.mbox --stream ``` - ---- - -If you use a different format and aren't able to figure out how to parse it, [create an issue](https://github.com/purarue/HPI/issues/new)