]> git.notmuchmail.org Git - notmuch/blob - NEWS
test/python: set LD_LIBRARY_PATH and PYTHONPATH to use local notmuch
[notmuch] / NEWS
1 Notmuch 0.10.2 (2011-12-04)
2 ===========================
3
4 Bug-fix release.
5 ----------------
6
7 Fix crash in python bindings.
8
9     The python bindings did not call g_type_init, which caused crashes
10     for some, but not all users.
11
12 Notmuch 0.10.1 (2011-11-25)
13 ===========================
14
15 Bug-fix release.
16 ----------------
17
18 Fix --help argument
19
20   Argument processing changes in 0.10 introduced a bug where "notmuch
21   --help" crashed while "notmuch help" worked fine. This is fixed in
22   0.10.1.
23
24 Notmuch 0.10 (2011-11-23)
25 =========================
26
27 New build and testing features
28 ------------------------------
29
30 Emacs tests are now done in dtach. This means that dtach  is now
31 needed to run the notmuch test suite, at least until the checking for
32 prerequisites is improved.
33
34 Full test coverage of the stashing feature in Emacs.
35
36 New command-line features
37 -------------------------
38
39 Add "notmuch restore --accumulate" option
40
41   The --accumulate switch causes the union of the existing and new tags to be
42   applied, instead of replacing each message's tags as they are read in from
43   the dump file.
44
45 Add search terms to  "notmuch dump"
46
47   The dump command now takes an optional search term much like notmuch
48   search/show/tag. The output file argument of dump is deprecated in
49   favour of using stdout.
50
51 Add "notmuch search" --offset and --limit options
52
53   The search command now takes options --offset=[-]N and --limit=N to limit
54   the number of results shown.
55
56 Add "notmuch count --output" option
57
58   The count command is now capable of counting threads in addition to
59   messages. This is selected using the new --output=(threads|messages) option.
60
61 New emacs UI features
62 ---------------------
63
64 Add tab-completion for notmuch-search and notmuch-search-filter
65
66   These functions now support completion tags for query parts
67   starting with "tag:".
68
69 Turn "id:MSG-ID" links into buttons associated with notmuch searches
70
71   Text of the form "id:MSG-ID" in mails is now a clickable button that
72   opens a notmuch search for the given message id.
73
74 Add keybinding ('c I') for stashing Message-ID's without an id: prefix
75
76   Reduces manual labour when stashing them for use outside notmuch.
77
78 Do not query on notmuch-search exit
79
80    It is harmless to kill the external notmuch process, so the user
81    is no longer interrogated when they interrupt a search.
82
83 Performance
84 -----------
85
86 Emacs now constructs large search buffers more efficiently
87
88 Search avoids opening and parsing message files
89
90   We now store more information in the database so search no longer
91   has to open every message file to get basic headers.  This can
92   improve search speed by as much as 10X, but taking advantage of this
93   requires a database rebuild:
94
95         notmuch dump > notmuch.dump
96         # Backup, then remove notmuch database ($MAIL/.notmuch)
97         notmuch new
98         notmuch restore notmuch.dump
99
100 New collection of add-on tools
101 ------------------------------
102
103 The source directory "contrib" contains tools built on notmuch.  These
104 tools are not part of notmuch, and you should check their individual
105 licenses.  Feel free to report problems with them to the notmuch
106 mailing list.
107
108 nmbug - share tags with a given prefix
109
110    nmbug helps maintain a git repo containing all tags with a given
111    prefix (by default "notmuch::"). Tags can be shared by commiting
112    them to git in one location and restoring in another.
113
114 Notmuch 0.9 (2011-10-01)
115 ========================
116
117 New, general features
118 ---------------------
119
120 Correct handling of interruptions during "notmuch new"
121
122   "notmuch new" now operates as a series of small, self-consistent
123   transactions, so it can correctly resume after an interruption or
124   crash.  Previously, interruption could lose existing tags, fail to
125   detect messages on resume, or leave the database in a state
126   temporarily or permanently inconsistent with the mail store.
127
128 Library changes
129 ---------------
130
131 New functions
132
133   notmuch_database_begin_atomic and notmuch_database_end_atomic allow
134   multiple database operations to be performed atomically.
135
136   notmuch_database_find_message_by_filename does exactly what it says.
137
138 API changes
139
140   notmuch_database_find_message (and n_d_f_m_by_filename) now return
141   a status indicator and uses an output parameter for the
142   message. This change required changing the SONAME of libnotmuch to
143   libnotmuch.so.2
144
145 Python bindings changes
146 -----------------------
147
148   - Re-encode python unicode objects to utf-8 before passing back to
149     libnotmuch.
150   - Support Database().begin_atomic()/end_atomic()
151   - Support Database().find_message_by_filename()
152     NB! This needs a db opened in READ-WRITE mode currently, or it will crash
153     the python process. The is a limitation (=bug) of the underlying libnotmuch.
154   - Fixes where we would not throw NotmuchErrors when we should (Justus Winter)
155   - Update for n_d_find_message* API changes (see above).
156
157 Ruby bindings changes
158 ---------------------
159
160   - Wrap new library functions notmuch_database_{begin,end}_atomic.
161   - Add new exception Notmuch::UnbalancedAtomicError.
162   - Rename destroy  to destroy! according to Ruby naming conventions.
163   - Update for n_d_find_message* API changes (see above).
164
165 Emacs improvements
166 ------------------
167
168   * Add gpg callback to crypto sigstatus buttons to retrieve/refresh
169     signing key.
170   * Add notmuch-show-refresh-view function (and corresponding binding)
171     to refresh the view of a notmuch-show buffer.
172
173 Reply formatting cleanup
174 ------------------------
175
176   "notmuch reply" no longer includes notification that non-leafnode
177   MIME parts are being suppressed.
178
179 Notmuch 0.8 (2011-09-10)
180 ========================
181
182 Improved handling of message/rfc822 parts
183
184   Both in the CLI and the emacs interface.  Output of rfc822 parts now
185   includes the primary headers, as well as the body and all subparts.
186   Output of the completely raw rfc822-formatted message, including all
187   headers, is unfortunately not yet supported (but hopefully will be
188   soon).
189
190 Improved Build system portability
191
192   Certain parts of the shell script generating notmuch.sym were
193   specific to the GNU versions of sed and nm. The new version should
194   be more portable to e.g. OpenBSD.
195
196 Documentation update for Ruby bindings
197
198   Added documentation, typo fixes, and improved support for rdoc.
199
200 Unicode, iterator, PEP8 changes for python bindings
201
202   - PEP8 (code formatting) changes for python files.
203   - Remove Tags.__len__ ; see 0.6 release notes for motivation.
204   - Decode headers as UTF8, encode (unicode) database paths as UTF8.
205
206 Notmuch 0.7 (2011-08-01)
207 ========================
208
209 Vim interface improvements
210 --------------------------
211
212 Jason Woofenden provided a number of bug fixes for the Vim interface
213
214   * fix citation/signature fold lengths
215   * fix cig/cit parsing within multipart/*
216   * fix on-screen instructions for show-signature
217   * fix from list reformatting in search view
218   * fix space key: now archives (did opposite)
219
220 Uwe Kleine-König contributed
221
222   * use full path for sendmail/doc fix
223   * fix compose temp file name
224
225 Python Bindings changes
226 -----------------------
227
228 Sebastian Spaeth contributed two changes related to unicode and UTF8:
229
230   * message tags are now explicitly unicode
231   * query string is encoded as a UTF8 byte string
232
233 Build-System improvements
234 ------------------------
235
236 Generate notmuch.sym after the relevant object files
237
238   This fixes a bug in parallel building. Thanks to Thomas Jost for the
239   patch.
240
241 Notmuch 0.6.1 (2011-07-17)
242 ==========================
243
244 Bug-fix release.
245 ----------------
246
247 Re-export Xapian exception typeinfo symbols.
248
249   It turned out our aggressive symbol hiding caused problems for
250   people running gcc 4.4.5.
251
252 Notmuch 0.6 (2011-07-01)
253 =======================
254 New, general features
255 ---------------------
256 Folder-based searching
257
258   Notmuch queries can now include a search term to match the
259   directories in which mail files are stored (within the mail
260   storage). The syntax is as follows:
261
262         folder:<path>
263
264   For example, one might use things such as:
265
266         folder:spam
267         folder:2011-*
268         folder:work/todo
269
270   to match any path containing a directory "spam", "work/todo", or
271   containing a directory starting with "2011-", respectively.
272
273   This feature is particularly useful for users of delivery-agent
274   software (such as procmail or maildrop) that is filtering mail and
275   delivering it to particular folders, or users of systems such as
276   Gmail that use filesystem directories to indicate message tags.
277
278   NOTE: Only messages that are newly indexed with this version of
279   notmuch will be searchable with folder: terms. In order to enable
280   this feature for all mail, the entire notmuch index will need to be
281   rebuilt as follows:
282
283         notmuch dump > notmuch.dump
284         # Backup, then remove notmuch database ($MAIL/.notmuch)
285         notmuch new
286         notmuch restore notmuch.dump
287
288 Support for PGP/MIME
289
290   Both the command line interface and the emacs-interface have new
291   support for PGP/MIME, detailed below. Thanks to Daniel Kahn Gillmor
292   and Jameson Graef Rollins for making this happen.
293
294 New, automatic tags: "signed" and "encrypted"
295
296   These tags will automatically be applied to messages containing
297   multipart/signed and multipart/encrypted parts.
298
299   NOTE: Only messages that are newly indexed with this version of
300   notmuch will receive these tags.
301
302 New command-line features
303 -------------------------
304 Add new "notmuch show --verify" option for signature verification
305
306   This option instruct notmuch to verify the signature of
307   PGP/MIME-signed parts.
308
309 Add new "notmuch show --decrypt" and "notmuch reply --decrypt" options
310
311   This option instructs notmuch to decrypt PGP/MIME-encrypted parts.
312   Note that this feature currently requires gpg-agent and a passphrase entry
313   tool (e.g. pinentry-gtk or pinentry-curses).
314
315 Proper nesting of multipart parts in "notmuch show" output
316
317   MIME parts are now display with proper nesting to reflect original
318   MIME hierarchy of a message. This allows clients to correctly
319   analyze the MIME structure, (such as, for example, determining to
320   which parts a signature part applies).
321
322 Add new "notmuch show --part" option
323
324   This is a replacement for the older "notmuch part" command, (which
325   is now deprecated—it should still work as always, but is no longer
326   documented). Putting part output under "notmuch show" allows for all
327   of the "notmuch show" options to be applied when extracting a single
328   part, (such as --format=json for extracting a message part with JSON
329   formatting).
330
331 Deprecate "notmuch search-tags", (in favor of "notmuch search --output=tags *")
332
333   The "notmuch search-tags" sub-command has been redundant since the
334   addition of the --output=tags option to "notmuch search". We now
335   make that more clear by deprecating "notmuch search-tags", (dropping
336   it from the documentation). We do continue to support the old syntax
337   by translating it internally to the new call.
338
339 Performance improvements
340 ------------------------
341 Faster searches (by doing fewer searches to construct threads)
342
343   Whenever a user asks for search results as threads, notmuch first
344   performs a search for messages matching the query, then performs
345   additional searches to find other messages in the resulting threads.
346
347   Removing inefficiencies and redundancies in these secondary searches
348   results in a measured speedups of 1.5x for a typical search.
349
350 Faster searches (by doing fewer passes to gather message data)
351
352   Optimizing Xapian data access patterns (using a single pass to get
353   all message-document data rather than a pass for each data type)
354   results in a measured speedup of 1.7x for a typical search.
355
356   The benefits of this optimization combine with the preceding
357   optimization. With both in place, Austin Clements measured a speedup
358   of 2.5x for a search of all messages in his inbox (was 4.5s, now
359   1.8s). Thanks, Austin!
360
361 Faster initial indexing
362
363   More efficient indexing of new messages results in a measured
364   speedup of 1.4x for the initial indexing of 3 GB of mail (1h 14m
365   rather than 1h 46m). Thanks to Austin Clements and Michal Sojka.
366
367 Make "notmuch new" faster for unchanged directories
368
369   Optimizing to not do any further examinations of sub-directories
370   when the filesystem indicates that a directory is unchanged from the
371   last "notmuch new" results in measured speedups of 8.5 for the "No
372   new mail" case, (was 0.77s, now 0.09s). Thanks to Karel Zak.
373
374 New emacs-interface features
375 ----------------------------
376
377 Support for PGP/MIME (GnuPG)
378
379   Automatically indicate validity of signatures for multipart/signed
380   messages.  Automatically display decrypted content for
381   multipart/encrypted messages.  See the emacs variable
382   notmuch-crypto-process-mime for more information. Note that this
383   needs gpg-agent and a pinentry tool just as the command line tools.
384   Also note there is no support SMIME yet.
385
386 Output of pipe command is now displayed if pipe command fails
387
388   This is extremely useful in the common use case of piping a patch to
389   "git am". If git fails to cleanly merge the patch the error messages
390   from the failed merge are now clearly displayed to the user, (where
391   previously they were silently hidden from the user).
392
393 User-selectable From address
394
395   A user can choose which configured email addresses should be used as
396   the From address whenever composing a new message. To do so, simply
397   press C-u before the command which will open a new message. Emacs
398   will prompt for the from address to use.
399
400   The user can customize the "Notmuch Identities" setting in the
401   notmuch customize group in order to use addresses other than those in
402   the notmuch configuration file if desired.
403
404   The user can also choose to always be prompted for the from address
405   when composing a new message (without having to use C-u) by setting
406   the "Notmuch Always Prompt For Sender" option in the notmuch
407   customize group.
408
409 Hiding of repeated subjects in collapsed thread view
410
411   In notmuch-show mode, if a collapsed message has the same subject as
412   its parent, the subject is not shown.
413
414 Automatic detection and hiding of original message in top-posted message
415
416   When a message contains a line looking something like:
417
418         ----- Original Message -----
419
420   emacs hides this and all subsequent lines as an "original message",
421   (allowing the user to click or press enter on the "original message"
422   button to display it again). This makes the handling of top-posted
423   citations work much like conventional citations.
424
425 New hooks for running code when tags are modified
426
427   Some users want to perform additional actions whenever a particular
428   tag is added/removed from a message. This could be used to, for
429   example, interface with some external spam-recognition training
430   tool. To facilitate this, two new hooks are added which can be
431   modified in the following settings of the notmuch customize group:
432
433         Notmuch Before Tag Hook
434         Notmuch After Tag Hook
435
436 New optional support for hiding some multipart/alternative parts
437
438   Many emails are sent with redundant content within a
439   multipart/alternative group (such as a text/plain part as well as a
440   text/html part). Users can configure the setting:
441
442         Notmuch Show All Multipart/Alternative Parts
443
444   to "off" in the notmuch customize group to have the interface
445   automatically hide some part alternatives (such as text/html
446   parts). This new part hiding is not configured by default yet
447   because there's not yet a simple way to re-display such a hidden
448   part if it is not actually redundant with a displayed part.
449
450 Better rendering of text/x-vcalendar parts
451
452   These parts are now displayed in a format suitable for use with the
453   emacs diary.
454
455 Avoid getting confused by Subject and Author fields with newline characters
456
457   Replacing all characters with ASCII code less than 32 with a question mark.
458
459 Cleaner display of From line in email messages (remove double quotes,
460 and drop "name" if it's actually just a repeat of the email address).
461
462 Vim interface improvements
463 --------------------------
464 Felipe Contreras provided a number of updates for the vim interface:
465
466   * Using sendmail directly rather than mailx,
467   * Implementing archive in show view
468   * Add support to mark as read in show and search views
469   * Add delete commands
470   * Various cleanups.
471
472 Bindings improvements
473 ---------------------
474 Ruby bindings are now much more complete
475
476   Including QUERY.sort, QUERY.to_s, MESSAGE.maildir_flags_to_tags,
477   MESSAGE.tags_to_maildir_flags, and MESSAGE.get_filenames
478
479 * Python bindings have been updated and extended
480   (docs online at http://packages.python.org/notmuch/)
481
482   New bindings:
483   - Message().get_filenames(),
484   - Message().tags_to_maildir_flags(),Message().maildir_flags_to_tags()
485   - list(Threads()) and list(Messages) works now
486
487   - Message().__cmp__() and __hash__()
488   These allow, for example:
489         if msg1 == msg2: ...
490
491   As well as set arithmetic on Messages():
492
493         s1, s2= set(msgs1), set(msgs2)
494         s1.union(s2)
495         s2 -= s1
496
497    Removed:
498      - len(Messages()) as it exhausted the iterator.
499        Use len(list(Messages())) or
500        Query.count_messages() to get the length.
501
502 Added initial Go bindings in bindings/go
503
504 New build-system features
505 -------------------------
506 Added support for building in a directory other than the source directory
507
508   This can be used with the widely-supported idiom of simply running
509   the configure script from some other directory:
510
511         mkdir build
512         cd build
513         ../configure
514         make
515
516 Fix to save configure options for future, implicit runs of configure
517
518   When a user updates the source (such as with "git pull") calling
519   "make" may cause an automatic re-run of the configure script. When
520   this happens, the configure script will automatically be called with
521   the same options the user originally passed in the most-recent
522   manual invocation of configure.
523
524 New test-suite feature
525 ----------------------
526 Binary for bash for running test suite now located via PATH.
527
528   The notmuch test suite requires a fairly recent version of bash (>=
529   bash 4). As some systems supply an older version of bash at
530   /bin/bash, the test suite is now updated to search $PATH to locate
531   the bash binary. This allows users of systems with old /bin/bash to
532   simply install bash >= 4 somewhere on $PATH before /bin and then use
533   the test suite.
534
535 Support for testing output with a trailing newline.
536
537   Previously, some tests would fail to notice a difference in the
538   presence/absence of a trailing newline in a program output, (which
539   has led to bugs in the past). Now, carefully-written tests (using
540   test_expect_equal_file rather than test_expect_equal) will detect
541   any change in the presence/absence of a trailing newline. Many tests
542   are updated to take advantage of this.
543
544 Avoiding accessing user's $HOME while running test suite
545
546   The test suite now carefully creates its own HOME directory. This
547   allows the test suite to be run with no existing HOME directory, (as
548   some build systems apparently do), and avoids test-suite differences
549   due to configuration files in the users HOME directory.
550
551
552 General bug fixes
553 -----------------
554 Output *all* files for "notmuch search --output=files"
555
556   For the cases where multiple files have the same Message ID,
557   previous versions of notmuch would output only one such file. This
558   command is now fixed to correctly output all files.
559
560 Fixed spurious search results from "overlapped" indexing of addresses
561
562   This fixed a bug where a search for:
563
564         to:user@elsewhere.com
565
566   would incorrectly match a message sent:
567
568         To: user@example,com, someone@elsewhere.com
569
570 Fix --output=json when search has no results
571
572   A bug present since notmuch 0.4 had caused searches with no results
573   to produce an invalid json object. This is now fixed to cleanly
574   return a valid json object representing an empty array "[]" as
575   expected.
576
577 fix the automatic detection of the From address for "notmuch reply"
578 from the Received headers in some cases.
579
580 Fix core dump on DragonFlyBSD due to -1 return value from
581 sysconf(_SC_GETPW_R_SIZE_MAX).
582
583 Cleaned up several memory leaks
584
585 Eliminated a few, rare segmentation faults and a double-free.
586
587 Fix libnotmuch library to only export notmuch API functions
588
589   Previous release of the notmuch library also exported some Xapian
590   C++ exception type symbols. These were never part of the library
591   interface and were never intended to be exported.
592
593 Emacs-interface bug fixes
594 -------------------------
595 Display any unexpected output or errors from "notmuch search" invocations
596
597   Previously any misformatted output or trailing error messages were
598   silently ignored. This output is now clearly displayed. This fix was
599   very helpful in identifying and fixing the bug described below.
600
601 Fix bug where some threads would be missing from large search results
602
603   When a search returned a "large" number of results, the emacs
604   interface was incorrectly dropping one thread every time the output
605   of the "notmuch search" process spanned the emacs read-buffer. This
606   is now fixed.
607
608 Avoid re-compression of .gz files (and similar) when saving attachment
609
610   Emacs was being too clever for its own good and trying to
611   re-compress pre-compressed .gz files when saving such attachments
612   (potentially corrupting the attachment). The emacs interface is
613   fixed to avoid this bug.
614
615 Fix hiding of a message when a previously-hidden citation is visible
616
617   Previously the citation would remain visible in this case. This is
618   fixed so that hiding a message hides all parts.
619
620 Notmuch 0.5 (2010-11-11)
621 ========================
622 New, general features
623 ---------------------
624 Maildir-flag synchronization
625
626   Notmuch now knows how to synchronize flags in maildir filenames with
627   tags in the notmuch database. The following flag/tag mappings are
628   supported:
629
630         Flag <-> Tag
631         ----     -----
632         'D'      draft
633         'F'      flagged
634         'P'      passed
635         'R'      replied
636         'S'      unread (added when 'S' flag is not present)
637
638   The synchronization occurs in both directions, (for example, adding
639   the 'S' flag to a file will cause the "unread" tag to be added, and
640   adding the "replied" tag to a message will cause the file to be
641   renamed with an 'R' flag).
642
643   This synchronization is enabled by default for users of the
644   command-line interface, (though only files in directories named
645   "cur" or "new" will be renamed). It can be disabled by setting the
646   new maildir.synchronize_flags option in the configuration file. For
647   example:
648
649         notmuch config set maildir.synchronize_flags false
650
651   Users upgrading may also want to run "notmuch setup" once (just
652   accept the existing configuration) to get a new, nicely-commented
653   [maildir] section added to the configuration file.
654
655   For users of the notmuch library, the new synchronization
656   functionality is available with the following two new functions:
657
658         notmuch_message_maildir_flags_to_tags
659         notmuch_message_tags_to_maildir_flags
660
661   It is anticipated that future improvements to this support will
662   allow for safe synchronization of the 'T' flag with the "deleted"
663   tag, as well as support for custom flag/tag mappings.
664
665 New library features
666 --------------------
667 Support for querying multiple filenames for a single message
668
669   It is common for the mailstore to contain multiple files with the
670   same message ID. Previously, notmuch would always hide these
671   duplicate files, (returning a single, arbitrary filename with
672   notmuch_message_get_filename).
673
674   With this release, library users can access all filenames for a
675   message with the new function:
676
677         notmuch_message_get_filenames
678
679   Together with notmuch_filenames_valid, notmuch_filenames_get, and
680   notmuch_filenames_move_to_next it is now possible to iterate over
681   all available filenames for a given message.
682
683 New command-line features
684 -------------------------
685 New "notmuch show --format=raw" for getting at original email contents
686
687   This new feature allows for a fully-functional email client to be
688   built on top of the notmuch command-line without needing any direct
689   access to the mail store itself.
690
691   For example, it's now possible to run "emacs -f notmuch" on a local
692   machine with only ssh access to the mail store/notmuch database. To
693   do this, simply set the notmuch-command variable in emacs to the
694   name of a script containing:
695
696         ssh user@host notmuch "$@"
697
698   If the ssh client has enabled connection sharing (ControlMaster
699   option in OpenSSH), the emacs interface can be quite responsive this
700   way.
701
702 General bug fixes
703 -----------------
704 Fix "notmuch search" to print nothing when nothing matches
705
706   The 0.4 release had a bug in which:
707
708         notmuch search <expression-with-no-matches>
709
710   would produce a single blank line of output, (where previous
711   versions would produce no output. This fix also causes a change in
712   the --format=json output, (which would previously produce "[]" and
713   now produces nothing).
714
715 Emacs interface improvements
716 ----------------------------
717 Fix to allow pipe ('|') command to work when using notmuch over ssh
718
719 Fix count of lines in hidden signatures.
720
721 Omit repeated subject lines in (collapsed) thread display.
722
723 Display current thread subject in a header line.
724
725 Provide a "c i" binding to copy a thread ID from the search view.
726
727 Allow for notmuch-fcc-dirs to have a value of nil.
728
729   Also, the more complex form of notmuch-fcc-dirs now has a slightly
730   different format. It no longer has a special first-element, fallback
731   string. Instead it's now a list of cons cells where the car of each
732   cell is a regular expression to be matched against the sender
733   address, and the cdr is the name of a folder to use for an FCC. So
734   the old fallback behavior can be achieved by including a final cell
735   of (".*" . "default-fcc-folder").
736
737 Vim interface improvements
738 --------------------------
739 Felipe Contreras provided a number of updates for the vim interface.
740
741   These include optimizations, support for newer versions of vim, fixed
742   support for sending mail on modern systems, new commands, and
743   various cleanups.
744
745 New bindings
746 ------------
747 Added initial ruby bindings in bindings/ruby
748
749 Notmuch 0.4 (2010-11-01)
750 ========================
751 New command-line features
752 -------------------------
753 notmuch search --output=(summary|threads|messages|tags|files)
754
755   This new option allows for particular items to be returned from
756   notmuch searches. The "summary" option is the default and behaves
757   just as "notmuch search" has historically behaved.
758
759   The new option values allow for thread IDs, message IDs, lists of
760   tags, and lists of filenames to be returned from searches. It is
761   expected that this new option will be very useful in shell
762   scripts. For example:
763
764         for file in $(notmuch search --output=files <search-terms>); do
765                 <operations-on> "$file"
766         done
767
768 notmuch show --format=mbox <search-specification>
769
770   This new option allows for the messages matching a search
771   specification to be presented as an mbox. Specifically the "mboxrd"
772   format is used which allows for reversible quoting of lines
773   beginning with "From ". A reader should remove a single '>' from the
774   beginning of all lines beginning with one or more '>' characters
775   followed by the 5 characters "From ".
776
777 notmuch config [get|set] <section>.<item> [value ...]
778
779   The new top-level "config" command allows for any value in the
780   notmuch configuration file to be queried or set to a new value. Both
781   single-valued and multi-valued items are supported, as our any
782   custom items stored in the configuration file.
783
784 Avoid setting Bcc header in "notmuch reply"
785
786   We decided that this was a bit heavy-handed as the actual mail
787   user-agent should be responsible for setting any Bcc option. Also,
788   see below for the notmuch/emacs user-agent now setting an Fcc by
789   default rather than Bcc.
790
791 New library features
792 --------------------
793 Add notmuch_query_get_query_string and notmuch_query_get_sort
794
795   These are simply functions for querying properties of a
796   notmuch_query_t object.
797
798 New emacs features
799 ------------------
800 Enable Fcc of all sent messages by default (to "sent" directory)
801
802   All messages sent from the emacs interface will now be saved to the
803   notmuch mail store where they will be incorporated to the database
804   by the next "notmuch new". By default, messages are saved to the
805   "sent" directory at the top-level of the mail store. This directory
806   can be customized by means of the "Notmuch Fcc Dirs" option in the
807   notmuch customize interface.
808
809 Ability to all open messages in a thread to a pipe
810
811   Historically, the '|' keybinding allows for piping a single message
812   to an external command. Now, by prefixing this key with a prefix
813   argument, (for example, by pressing "Control-U |"), all open
814   messages in the current thread will be sent to the external command.
815
816 Optional support for detecting inline patches
817
818   This hook is disabled by default but can be enabled with a checkbox
819   under "Notmuch Show Insert Text/Plain Hook" in the notmuch customize
820   interface. It allows for inline patches to be detected and treated
821   as if they were attachments, (with context-sensitive highlighting).
822
823 Automatically tag messages as "replied" when sending a reply
824
825   Messages replied to within the emacs interface will now be tagged as
826   "replied". This feature can easily be customized to add or remove
827   other tags as well. For example, a user might use a tag of
828   "needs-reply" and can configure this feature to automatically remove
829   that tag when replying. See "Notmuch Message Mark Replied" in the
830   notmuch customize interface.
831
832 Allow search-result color specifications to overlay each other
833
834   For example, one tag can specify the background color of matching
835   lines, while another can specify the foreground. With this change,
836   both settings will now be visible simultaneously, (which was not the
837   case in previous releases). See "Notmuch Search Line Faces" in the
838   notmuch customize interface.
839
840 Make hidden author names still available for incremental search.
841
842   When there is insufficient space to display all authors of a thread
843   in search results, the names of hidden authors are now still made
844   available to emacs' incremental search commands. As the user
845   searches, matching lines will temporarily expand to show the hidden
846   names.
847
848 New binding of Control-TAB (works like TAB in reverse)
849
850   Many notmuch nodes already use TAB to navigate forward through
851   various items allowing actions, (message headers, email attachments,
852   etc.). The new Control-TAB binding operates similarly but in the
853   opposite direction.
854
855 New build-system features
856 -------------------------
857 Various portability fixes have been applied
858
859   These include fixes for build failures on at least Solaris, FreeBSD,
860   and Fedora systems. We're hopeful that the notmuch code base is now
861   more portable than ever before.
862
863 Arrange for libnotmuch to be found automatically after make install
864
865   The notmuch build system is now careful to help the user avoid
866   errors of the form "libnotmuch.so could not be found" immediately
867   after installing. This support takes two forms:
868
869         1. If the library is installed to a system directory,
870            (configured in /etc/ld.so.conf), then "make install" will
871            automatically run ldconfig.
872
873         2. If the library is installed to a non-system directory, the
874            build system adds a DR_RUNPATH entry to the final binary
875            pointing to the directory to which the library is installed.
876
877   When this support works, the user should be able to run notmuch
878   immediately after "make install", without any errors trying to find
879   the notmuch library, and without having to manually set environment
880   variables such as LD_LIBRARY_PATH.
881
882 Check compiler/linker options before using them
883
884   The configure script now carefully checks that any desired
885   compilation options, (whether for enabling compiler warnings, or for
886   embedding rpath, etc.), are supported. Only supported options are
887   used in the resulting Makefile.
888
889 New test-suite features
890 -----------------------
891 New modularization of test suite.
892
893   Thanks to a gracious relicensing of the test-suite infrastructure
894   from the git project, notmuch now has a modular test suite. This
895   provides the ability to run individual sections of the test suite
896   rather than the whole things. It also provides better summary of
897   test results, with support for tests that are expected to fail
898   (BROKEN and FIXED) in addition to PASS and FAIL. Finally, it makes
899   it easy to run the test suite within valgrind (pass --valgrind to
900   notmuch-test or to any sub-script) which has been very useful.
901
902 New testing of emacs interface.
903
904   The test suite has been augmented to allow automated testing of the
905   emacs interfaces. So far, this includes basic searches, display of
906   threads, and tag manipulation. This also includes a test that a new
907   message can successfully be sent out through a (dummy) SMTP server
908   and that said message is successfully integrated into the notmuch
909   database via the FCC setting.
910
911 General bug fixes
912 -----------------
913 Fix potential corruption of database when "notmuch new " is interrupted.
914
915   Previously, an interruption of "notmuch new" would (rarely) result
916   in a corrupt database. The corruption would manifest itself by a
917   persistent error of the form:
918
919         document ID of 1234 has no thread ID
920
921   The message-adding code has been carefully audited and reworked to
922   avoid this sort of corruption regardless of when it is interrupted.
923
924 Fix failure with extremely long message ID headers.
925
926   Previously, a message with an extremely long message ID, (say, more
927   than 300 characters), would fail to be added to notmuch, (triggering
928   Xapian exceptions). This has now been fixed.
929
930 Fix for messages with "charset=unknown-8bit"
931
932   Previously, messages with this charset would cause notmuch to emit a
933   GMime warning, (which would then trip up emacs or other interfaces
934   parsing the notmuch results).
935
936 Fix notmuch_query_search_threads function to return NULL on any exception
937
938 Fix "notmuch search" to return non-zero if notmuch_query_search_threads fails
939
940   Previously, this command could confusingly report a Xapian
941   exception, yet still return an error code of 0. It now correctly
942   returns a failing error code of 1 in this case.
943
944 Emacs bug fixes
945 ---------------
946 Fix to handle a message with a subject containing, for example "[1234]"
947
948   Previously, a message subject containing a sequence of digits within
949   square brackets would cause the emacs interface to mis-parse the
950   output of "notmuch search". This would result in the message being
951   mis-displayed and prevent the user from manipulating the message in
952   the emacs interface.
953
954 Fix to correctly handle message IDs containing ".."
955
956   The emacs interface now properly quotes message IDs to avoid a
957   Xapian bug in which the ".." within a message ID would be
958   misinterpreted as a numeric range specification.
959
960 Python-binding fixes
961 --------------------
962 The python bindings for notmuch have been updated to work with python3.
963
964 Debian-specific fixes
965 ---------------------
966 Fix emacs initialization so "M-x notmuch" works for users by default.
967
968   Now, a new Debian user can immediately run "emacs -f notmuch" after
969   "apt-get install notmuch". Previously, the user would have had to
970   edit the ~/.emacs file to add "(require 'notmuch)" before this would
971   work.
972
973 Notmuch 0.3.1 (2010-04-27)
974 ==========================
975 General bug fixes
976 -----------------
977 Fix an infinite loop in "notmuch reply"
978
979   This bug could be triggered by replying to a message where the
980   user's primary email address did not appear in the To: header and
981   the user had not configured any secondary email addresses. The bug
982   was a simple re-use of the same iterator variable in nested loops.
983
984 Fix a potential SEGV in "notmuch search"
985
986   This bug could be triggered by an author name ending in a ','.
987   Admittedly - that's almost certainly a spam email, but we never
988   want notmuch to crash.
989
990 Emacs bug fixes
991 ---------------
992 Fix calculations for line wrapping in the primary "notmuch" view.
993
994 Fix Fcc support to prompt to create a directory if the specified Fcc
995 directory does not exist.
996
997 Build fix
998 ---------
999 Fix build on OpenSolaris (at least) due to missing 'extern "C"' block.
1000
1001   Without this, the C++ sources could not find strcasestr and the
1002   final linking of notmuch would fail.
1003
1004 Notmuch 0.3 (2010-04-27)
1005 ========================
1006 New command-line features
1007 -------------------------
1008 User-configurable tags for new messages
1009
1010   A new "new.tags" option is available in the configuration file to
1011   determine which tags are applied to new messages. Run "notmuch
1012   setup" to generate new documentation within ~/.notmuch-config on how
1013   to specify this value.
1014
1015 Threads search results named based on subjects that match search
1016
1017   This means that when new mails arrived to a thread you've previously
1018   read, and the new mails have a new subject, you will see that
1019   subject in the search results rather than the old subject.
1020
1021 Faster operation of "notmuch tag" (avoid unneeded sorting)
1022
1023   Since the user just wants to tag all matching messages, we can make
1024   things perform a bit faster by avoiding the sort.
1025
1026 Even Better guessing of From: header for "notmuch reply"
1027
1028   Notmuch now looks at a number of headers when trying to figure out
1029   the best From: header to use in a reply. This is helpful if you have
1030   several configured email addresses, and you also subscribe to various
1031   mailing lists with different addresses, (so that mails you are
1032   replying to won't always include your subscribed address in the To:
1033   header).
1034
1035 Indication of author names that match a search
1036
1037   When notmuch displays threads as the result of a search, it now
1038   lists the authors that match the search before listing the other
1039   authors in the thread. It inserts a pipe '|' symbol between the last
1040   matching and first non-matching author. This is especially useful in
1041   a search that includes tag:unread. Now the authors of the unread
1042   messages in the thread are listed first.
1043
1044 New: Python bindings
1045 --------------------
1046 Sebastian Spaeth has contributed his python bindings for the notmuch
1047 library to the central repository. These bindings were previously
1048 known as "cnotmuch" within python but have now been renamed to be
1049 accessible with a simple, and more official-looking "import notmuch".
1050
1051 The bindings have already proven very useful as people proficient in
1052 python have been able to easily develop programs to do notmuch-based
1053 searches for email-address completion, maildir-flag synchronization,
1054 and other tasks.
1055
1056 These bindings are available within the bindings/python directory, but
1057 are not yet integrated into the top-level Makefiles, nor the top-level
1058 package-building scripts. Improvements are welcome.
1059
1060 Emacs interface improvements
1061 ----------------------------
1062 An entirely new initial view for notmuch, (friendly yet powerful)
1063
1064   Some of us call the new view "notmuch hello" but you can get at it
1065   by simply calling "emacs -f notmuch". The new view provides a search
1066   bar where new searches can be performed. It also displays a list of
1067   recent searches, along with a button to save any of these, giving it
1068   a new name as a "saved search". Many people find these "saved
1069   searches" one of the most convenient ways of organizing their mail,
1070   (providing all of the features of "folders" in other mail clients,
1071   but without any of the disadvantages).
1072
1073   Finally, this view can also optionally display all of the tags that
1074   exist in the database, along with a count for each tag, and a custom
1075   search of messages with that tag that's simply a click (or keypress)
1076   away.
1077
1078   Note: For users that liked the original mode of "emacs -f notmuch"
1079         immediately displaying a particular search result, we
1080         recommend instead running something like:
1081
1082                 emacs --eval '(notmuch search "tag:inbox" t)'
1083
1084         The "t" means to sort the messages in an "oldest first" order,
1085         (as notmuch would do previously by default). You can also
1086         leave that off to have your search results in "newest first"
1087         order.
1088
1089 Full-featured "customize" support for configuring notmuch
1090
1091   Notmuch now plugs in well to the emacs "customize" mode to make it
1092   much simpler to find things about the notmuch interface that can be
1093   tweaked by the user.
1094
1095   You can get to this mode by starting at the main "Customize" menu in
1096   emacs, then browsing through "Applications", "Mail", and
1097   "Notmuch". Or you can go straight to "M-x customize-group"
1098   "notmuch".
1099
1100   Once you're at the customize screen, you'll see a list of documented
1101   options that can be manipulated along with checkboxes, drop-down
1102   selectors, and text-entry boxes for configuring the various
1103   settings.
1104
1105 Support for doing tab-completion of email addresses
1106
1107   This support currently relies on an external program,
1108   (notmuch-addresses), that is not yet shipped with notmuch
1109   itself. But multiple, suitable implementations of this program have
1110   already been written that generate address completions by doing
1111   notmuch searches of your email collection. For example, providing
1112   first those addresses that you have composed messages to in the
1113   past, etc.
1114
1115   One such program (implemented in python with the python bindings to
1116   notmuch) is available via:
1117
1118         git clone  http://jkr.acm.jhu.edu/git/notmuch_addresses.git
1119
1120   Install that program as notmuch-addresses on your PATH, and then
1121   hitting TAB on a partial email address or name within the To: or Cc:
1122   line of an email message will provide matching completions.
1123
1124 Support for file-based (Fcc) delivery of sent messages to mail store
1125
1126   This isn't yet enabled by default. To enable this, one will have to
1127   set the "Notmuch Fcc Dirs" setting within the notmuch customize
1128   screen, (see its documentation there for details). We anticipate
1129   making this automatic in a future release.
1130
1131 New 'G' key binding to trigger mail refresh (G == "Get new mail")
1132
1133   The 'G' key works wherever '=' works. Before refreshing the screen
1134   it calls an external program that can be used to poll email servers,
1135   run notmuch new and setup specific tags for the new emails. The
1136   script to be called should be configured with the "Notmuch Poll
1137   Script" setting in the customize interface. This script will
1138   typically invoke "notmuch new" and then perhaps several "notmuch
1139   tag" commands.
1140
1141 Implement emacs message display with the JSON output from notmuch.
1142
1143   This is much more robust than the previous implementation, (where
1144   some HTML mails and mail quoting the notmuch code with the delimiter
1145   characters in it would cause the parser to fall over).
1146
1147 Better handling of HTML messages and MIME attachments (inline images!)
1148
1149   Allow for any MIME parts that emacs can display to be displayed
1150   inline. This includes inline viewing of image attachments, (provided
1151   the window is large enough to fit the image at its natural size).
1152
1153   Much more robust handling of HTML messages. Currently both text/plain
1154   and text/html alternates will be rendered next to each other. In a
1155   future release, users will be able to decide to see only one or the
1156   other representation.
1157
1158   Each attachment now has its own button so that attachments can be
1159   saved individually (the 'w' key is still available to save all
1160   attachments).
1161
1162 Customizable support for tidying of text/plain message content
1163
1164   Many new functions are available for tidying up message
1165   content. These include options such as wrapping long lines,
1166   compressing duplicate blank lines, etc.
1167
1168   Most of these are disabled by default, but can easily be enabled by
1169   clicking the available check boxes under the "Notmuch Show Insert
1170   Text/Plain Hook" within the notmuch customize screen.
1171
1172 New support for searchable citations (even when hidden)
1173
1174   When portions of overly-long citations are hidden, the contents of
1175   these citations will still be available for emacs' standard
1176   "incremental search" functions. When the search matches any portion
1177   of a hidden citation, the citation will become visible temporarily
1178   to display the search result.
1179
1180 More flexible handling of header visibility
1181
1182   As an answer to complaints from many users, the To, Cc, and Date
1183   headers of messages are no longer hidden by default. For those users
1184   that liked that these were hidden, a new "Notmuch Messages Headers
1185   Visible" option in the customize interface can be set to nil. The
1186   visibility of headers can still be toggled on a per-message basis
1187   with the 'h' keybinding.
1188
1189   For users that don't want to see some subset of those headers, the
1190   new "Notmuch Message Headers" variable can be customized to list
1191   only those headers that should be present in the display of a message.
1192
1193 The Return key now toggles message visibility anywhere
1194
1195   Previously this worked only on the first summary-line of a message.
1196
1197 Customizable formatting of search results
1198
1199   The user can easily customize the order, width, and formatting of
1200   the various fields in a "notmuch search" buffer. See the "Notmuch
1201   Search Result Format" section of the customize interface.
1202
1203 Generate nicer names for search buffers when using a saved search.
1204
1205 Add a notmuch User-Agent header when sending mail from notmuch/emacs.
1206
1207 New keybinding (M-Ret) to open all collapsed messages in a thread.
1208
1209 New library feature
1210 -------------------
1211 Provide a new NOTMUCH_SORT_UNSORTED value for queries
1212
1213   This can be somewhat faster when sorting simply isn't desired. For
1214   example when collecting a set of messages that will all be
1215   manipulated identically, (adding a tag, removing a tag, deleting the
1216   messages), then there's no advantage to sorting the messages by
1217   date.
1218
1219 Build fixes
1220 -----------
1221 Fix to compile against GMime 2.6
1222
1223   Previously notmuch insisted on being able to find GMime 2.4, (even
1224   though GMime 2.6 would have worked all along).
1225
1226 Fix configure script to accept (and ignore) various standard options.
1227
1228   For example, those that the Gentoo build scripts expect configure to
1229   accept are now all accepted.
1230
1231 Test suite
1232 ----------
1233 A large number of new tests for the many new features.
1234
1235 Better display of output from failed tests.
1236
1237   Now shows failures with diff rather than forcing the user to gaze at
1238   complete actual and expected output looking for deviation.
1239
1240 Notmuch 0.2 (2010-04-16)
1241 ========================
1242 This is the second release of the notmuch mail system, with actual
1243 detailed release notes this time!
1244
1245 This release consists of a number of minor new features that make
1246 notmuch more pleasant to use, and a few fairly major bug fixes.
1247
1248 We didn't quite hit our release target of "about a week" from the 0.1
1249 release, (0.2 is happening 11 days after 0.1), but we hope to do
1250 better for next week. Look forward to some major features coming to
1251 notmuch in subsequent releases.
1252
1253 -Carl
1254
1255 General features
1256 ----------------
1257 Better guessing of From: header.
1258
1259   Notmuch now tries harder to guess which configured address should be
1260   used as the From: line in a "notmuch reply". It will examine the
1261   Received: headers if it fails to find any configured address in To:
1262   or Cc:. This allows it to often choose the correct address even when
1263   replying to a message sent to a mailing list, and not directly to a
1264   configured address.
1265
1266 Make "notmuch count" with no arguments count all messages
1267
1268   Previously, it was hard to construct a search term that was
1269   guaranteed to match all messages.
1270
1271 Provide a new special-case search term of "*" to match all messages.
1272
1273   This can be used in any command accepting a search term, such as
1274   "notmuch search '*'". Note that you'll want to take care that the
1275   shell doesn't expand * against the current files. And note that the
1276   support for "*" is a special case. It's only meaningful as a single
1277   search term and loses its special meaning when combined with any
1278   other search terms.
1279
1280 Automatically detect thread connections even when a parent message is
1281 missing.
1282
1283   Previously, if two or more message were received with a common
1284   parent, but that parent was not received, then these messages would
1285   not be recognized as belonging to the same thread. This is now fixed
1286   so that such messages are properly connected in a thread.
1287
1288 General bug fixes
1289 -----------------
1290 Fix potential data loss in "notmuch new" with SIGINT
1291
1292   One code path in "notmuch new" was not properly handling
1293   SIGINT. Previously, this could lead to messages being removed from
1294   the database (and their tags being lost) if the user pressed
1295   Control-C while "notmuch new" was working.
1296
1297 Fix segfault when a message includes a MIME part that is empty.
1298
1299 Fix handling of non-ASCII characters with --format=json
1300
1301   Previously, characters outside the range of 7-bit ASCII were
1302   silently dropped from the JSON output. This led to corrupted display
1303   of utf-8 content in the upcoming notmuch web-based frontends.
1304
1305 Fix headers to be properly decoded in "notmuch reply"
1306
1307   Previously, the user might see:
1308
1309         Subject: Re: =?iso-8859-2?q?Rozlu=E8ka?=
1310
1311   rather than:
1312
1313         Subject: Re: Rozlučka
1314
1315   The former text is properly encoded to be RFC-compliant SMTP, will
1316   be sent correctly, and will be properly decoded by the
1317   recipient. But the user trying to edit the reply would likely be
1318   unable to read or edit that field in its encoded form.
1319
1320 Emacs client features
1321 ---------------------
1322 Show the last few lines of citations as well as the first few lines.
1323
1324   It's often the case that the last sentence of a citation is what is
1325   being replied to directly, so the last few lines are often much more
1326   important. The number of lines shown at the beginning and end of any
1327   citation can be configured, (notmuch-show-citation-lines-prefix and
1328   notmuch-show-citation-lines-suffix).
1329
1330 The '+' and '-' commands in the search view can now add and remove
1331 tags by region.
1332
1333   Selective bulk tagging is now possible by selecting a region of
1334   threads and then using either the '+' or '-' keybindings. Bulk
1335   tagging is still available for all threads matching the current
1336   search with the '*' binding.
1337
1338 More meaningful buffer names for thread-view buffers.
1339
1340   Notmuch now uses the Subject of the thread as the buffer
1341   name. Previously it was using the thread ID, which is a meaningless
1342   number to the user.
1343
1344 Provide for customized colors of threads in search view based on tags.
1345
1346   See the documentation of notmuch-search-line-faces, (or us "M-x
1347   customize" and browse to the "notmuch" group within "Applications"
1348   and "Mail"), for details on how to configure this colorization.
1349
1350 Build-system features
1351 ---------------------
1352 Add support to properly build libnotmuch on Darwin systems (OS X).
1353
1354 Add support to configure for many standard options.
1355
1356   We include actual support for:
1357
1358         --includedir --mandir --sysconfdir
1359
1360   And accept and silently ignore several more:
1361
1362         --build --infodir --libexecdir --localstatedir
1363         --disable-maintainer-mode --disable-dependency-tracking
1364
1365 Install emacs client in "make install" rather than requiring a
1366 separate "make install-emacs".
1367
1368 Automatically compute versions numbers between releases.
1369
1370   This support uses the git-describe notation, so a version such as
1371   0.1-144-g43cbbfc indicates a version that is 144 commits since the
1372   0.1 release and is available as git commit "43cbbfc".
1373
1374 Add a new "make test" target to run the test suite and actually verify
1375 its results.
1376
1377 Notmuch 0.1 (2010-04-05)
1378 ========================
1379 This is the first release of the notmuch mail system.
1380
1381 It includes the libnotmuch library, the notmuch command-line
1382 interface, and an emacs-based interface to notmuch.
1383
1384 Note: Notmuch will work best with Xapian 1.0.18 (or later) or Xapian
1385 1.1.4 (or later). Previous versions of Xapian (whether 1.0 or 1.1) had
1386 a performance bug that made notmuch very slow when modifying
1387 tags. This would cause distracting pauses when reading mail while
1388 notmuch would wait for Xapian when removing the "inbox" and "unread"
1389 tags from messages in a thread.