X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=howto.mdwn;h=2a4f3f3782579a1bf0e9761a481e2adc057b99fd;hb=9955a7fedfab57235e01edb137cc8e44df644884;hp=58868c6e474b546a33b43b95b8fda471f35b82ba;hpb=540b2879f1b505155b807bd6fcc23025b6e31297;p=notmuch-wiki
diff --git a/howto.mdwn b/howto.mdwn
index 58868c6..2a4f3f3 100644
--- a/howto.mdwn
+++ b/howto.mdwn
@@ -1,18 +1,57 @@
[[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
#How to...
-* .. print only filenames of a search
+Some tips about how to do some useful things with notmuch, and the
+various "third party" notmuch utilities.
-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:
+* **Receive mail**
- #!/usr/bin/env python
- import sys
- import notmuch
-
- q = notmuch.Database().create_query(" ".join(sys.argv[1:]))
- for m in q.search_messages(): print m.get_filename()
+ 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 it's own will work. Here are some generally
+ well-regarded mail retrieval tools:
-* .. sync notmuch tags and maildir flags
+ * [offlineimap](https://github.com/jgoerzen/offlineimap/wiki/) -
+ 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](/initial_tagging) for more info on intial tagging of messages.
+
+* **Print only filenames of a search (python bindings)**
+
+ Notmuch includes python bindings to the notmuch shared library,
+ called [cnotmuch](http://pypi.python.org/pypi/cnotmuch). Extensive
+ API documentation available.
+
+ 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
+ import notmuch
+ search = " ".join(sys.argv[1:])
+ q = notmuch.Database().create_query(search)
+ for m in q.search_messages():
+ print m.get_filename()
+
+* **Sync notmuch tags and maildir flags**
+
+ notmuch **since version 0.5** syncs maildir flags and respective
+ tags in both directions. This how to applies only to notmuch
+ prior 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
@@ -25,8 +64,8 @@ Given you have the python bindings installed (or simply set your PYTHONPATH envi
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
@@ -34,4 +73,3 @@ Given you have the python bindings installed (or simply set your PYTHONPATH envi
*id:1267450136-31749-1-git-send-email-Sebastian@SSpaeth.de* and can
be viewed as a [source diff in this git
repository](http://github.com/spaetz/notmuch-all-feature/commit/df3b087cefb85e9d16fd17540e348bcb854dd7ee).
-