]> git.cworth.org Git - notmuch-wiki/blobdiff - howto.mdwn
Update the heading
[notmuch-wiki] / howto.mdwn
index acd0173c5b3ab338f5e6cad96a37068209ba62aa..4dad0b6040a36428f985a1ac5fe455ed3b22ca36 100644 (file)
@@ -28,7 +28,7 @@ various "third party" notmuch utilities.
 
   See the [[initial_tagging]] page for more info on intial tagging of messages.
 
-* <span id="print_filenames">**Print only filenames of a search (python bindings)**</span>
+* <span id="python">**Use notmuch from python**</span>
 
   Notmuch includes python bindings to the notmuch shared
   library. Extensive API documentation [is
@@ -37,15 +37,14 @@ various "third party" notmuch utilities.
   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()
+  this snippet will produce a list of mails matching the given
+  expression:
+
+          >>> import notmuch
+          >>> db = notmuch.Database()
+          >>> query = db.create_query('tag:inbox AND NOT tag:killed')
+          >>> list(query.search_messages()) # doctest:+ELLIPSIS
+          [...]
 
 * <span id="sync_maildir_flags">**Sync notmuch tags and maildir flags**</span>