X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=howto.mdwn;h=0e75acc82bdc4b2aee8f9e957c6e8047a90d07a7;hb=d7c70a64d61ced5fca65ebf0cc998625994da538;hp=c62409fc9b35a2b243717202afacfd059f0afc0f;hpb=849b5df14e24d4e4b7215575315b7ad515326943;p=notmuch-wiki diff --git a/howto.mdwn b/howto.mdwn index c62409f..0e75acc 100644 --- a/howto.mdwn +++ b/howto.mdwn @@ -4,12 +4,40 @@ Some tips about how to do some useful things with notmuch, and the various "third party" notmuch utilities. -* Print only filenames of a search +* **Receive mail** - Given you have the python bindings installed (or simply set your - PYTHONPATH environment variable to point to the .../bindings/python - directory), this script will print the filenames of a matching - search: + Notmuch requires either [maildir + flag](http://cr.yp.to/proto/maildir.html) or a "mh"-style + maildirectory to operate on. Basically any setup in which each mail + is in a file of its own will work. Here are some generally + well-regarded mail retrieval tools: + + * [offlineimap](https://github.com/nicolas33/offlineimap/) - + quite useful and widely tested, it also offers a handy hook that + will come in useful a bit later in our setup. Also supports + "presynchook" and "postsynchook" command that will get run + whenever you sync. Point _postsynchook_ to a script that gets run + on every sync and that will do the automatic updating and tagging + of your notmuch database. + + * [mbsync](http://isync.sourceforge.net/) + + * [getmail](http://pyropus.ca/software/getmail/) + + * [fetchmail](http://fetchmail.berlios.de/) + + See the [[initial_tagging]] page for more info on intial tagging of messages. + +* **Print only filenames of a search (python bindings)** + + Notmuch includes [python bindings](http://pypi.python.org/pypi/notmuch) + to the notmuch shared library. Extensive API documentation + [is available](http://packages.python.org/notmuch). + + The bindings are very simple to use. As an example, given you have + the python bindings installed (or simply set your PYTHONPATH + environment variable to point to the .../bindings/python directory), + this script will print the filenames of a matching search: #!/usr/bin/env python import sys @@ -19,7 +47,11 @@ various "third party" notmuch utilities. for m in q.search_messages(): print m.get_filename() -* Sync notmuch tags and maildir flags +* **Sync notmuch tags and maildir flags** + + notmuch **since version 0.5** syncs maildir flags and respective + tags in both directions. This part applies only to notmuch prior to + version 0.5: Some IMAP users rely on maildir flags that convey the status "seen", "replied", "trashed", in order to synchronize the status of their @@ -27,13 +59,13 @@ various "third party" notmuch utilities. flag](http://cr.yp.to/proto/maildir.html) is simply a defined part of their filename). Notmuch will by default happily ignore those flags and will never modify them either, as there is no built-in - support for sunchronizing your notmuch tags with your imap maildir + support for synchronizing your notmuch tags with your imap maildir flags (seen, replied, trashed, etc). However there are currently 2 ways in which you can achieve synchronization. [notmuchsync](http://spaetz.github.com/notmuchsync/) is a utility - that allows synchronization in either direction, as well as pruning - of deleted files. + (based on the cnotmuch python bindings) that allows synchronization + in either direction, as well as pruning of deleted files. The second solution allows for fast maildir flag to notmuch tag synchronization (and only in that direction) requires patching the @@ -42,3 +74,43 @@ various "third party" notmuch utilities. be viewed as a [source diff in this git repository](http://github.com/spaetz/notmuch-all-feature/commit/df3b087cefb85e9d16fd17540e348bcb854dd7ee). +* **Using notmuch with Mutt** + + Notmuch is a great mail indexing tool that can also be used *in conjunction* + with existing Mail User Agents (MUA) instead of replacing them. The advantage + of such mixed solutions is that users can benefit from notmuch features (such + as full-text search and thread reconstruction) without *having to* change + MUA. + + A popular geek MUA is [the Mutt e-mail client](http://www.mutt.org); + integrating notmuch with Mutt is fairly straightforward. An + [**how to use Notmuch with Mutt**](http://upsilon.cc/~zack/blog/posts/2011/01/how_to_use_Notmuch_with_Mutt/) + has been written by Stefano Zacchiroli, together with some glue code. Check + out the + [howto](http://upsilon.cc/~zack/blog/posts/2011/01/how_to_use_Notmuch_with_Mutt/) + for more information. + + (Note by the howto author: I've linked the howto from this wiki rather + than splicing it in, in order to avoid duplication of information. If you + think it would be better to have it here, feel free to copy the text + here. The howto is + [available](http://git.upsilon.cc/cgi-bin/gitweb.cgi?p=zack-homepage.git;a=history;f=blog/posts/2011/01/how_to_use_Notmuch_with_Mutt.mdwn) + in markdown syntax from the Git repository of my homepage.) + +* **Automatically retagging the database (e.g., when upgrading versions)** + + Certain versions of notmuch include new automatic tags (for example, between + 0.3 and 0.10, automatic tagging of signed and encrypted messages was added). + However, for users running with databases created in older versions of + notmuch, these tags are missing in pre-existing messages and need to be + added. One way to do this is as follows: + + $ notmuch dump ~/out.nm + $ mv ~/Mail/.notmuch ~/.notmuch.bak + $ notmuch new + $ notmuch tag -inbox -unread '*' + $ notmuch restore --accumulate ~/out.nm + + At this point, one should run a sanity check on the tags, and if everything + has merged correctly, the ~/.notmuch.bak directory is expendable, as is + ~/out.nm.