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