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