Merge tag '0.18.2_rc1'
[notmuch] / NEWS
1 Notmuch 0.19 (UNRELEASED)
2 =========================
3
4 Emacs Interface
5 ---------------
6
7 Use the `j` key to access saved searches from anywhere in notmuch
8
9   `j` is now globally bound to `notmuch-jump`, which provides fast,
10   interactive keyboard shortcuts to saved searches.  For example,
11   with the default saved searches `j i` from anywhere in notmuch will
12   bring up the inbox.
13
14 Expanded default saved search settings
15
16   The default saved searches now include several more common searches,
17   as well as shortcut keys for `notmuch-jump`.
18
19 Library changes
20 ---------------
21
22 Add return status to notmuch_database_close and
23 notmuch_database_destroy
24
25 nmbug
26 -----
27
28 The Perl script has been translated to Python; you'll need Python 2.7
29 or anything from the 3.x line.  Most of the user-facing interface is
30 the same, but `nmbug help` is not `nmbug --help`, and the following nmbug
31 commands have slightly different interfaces: `archive`, `commit`,
32 `fetch`, `log`, `pull`, `push`, and `status`.  For details on the
33 new interface for a given command, run `nmbug COMMAND --help`.
34
35 nmbug-status
36 ------------
37
38 `nmbug-status` can now optionally load header and footer templates
39 from the config file.  Use something like:
40
41     {
42       "meta": {
43         "header": "<!DOCTYPE html>\n<html lang="en">\n...",
44         "footer": "</body></html>",
45          ...
46       },
47       ...
48     },
49
50 Python Bindings
51 ---------------
52
53 Add support for `notmuch_query_add_tag_exclude`
54
55 Build System
56 ------------
57
58 The notmuch binaries and libraries are now build with debugging symbols
59 by default.  Users concerned with disk space should change the
60 defaults when configuring or use the strip(1) command.
61
62 Notmuch 0.18.2 (2014-10-25)
63 ===========================
64
65 Test Suite
66 ----------
67
68 Portability and bug fixes for test suite to improve compatibility with Emacs 24.4, gdb 7.8, and the ppc64el architecture.
69
70 Notmuch 0.18.1 (2014-06-25)
71 ===========================
72
73 This is a bug fix and portability release.
74
75 Build System
76 ------------
77
78 Add a workaround for systems without zlib.pc
79
80 Make emacs install robust against the non-existence of emacs
81
82 Put notmuch lib directory first in RPATH
83
84 Fix handling of html_static_path in sphinx
85
86   Both the python bindings and the main docs had spurious settings of
87   this variable.
88
89 Test Suite
90 ----------
91
92 Use --quick when starting emacs
93
94   This avoids a hang in the T160-json tests.
95
96 Allow pending break points in atomicity script
97
98   This allows the atomicity tests to run on several more architectures/OSes.
99
100 Command-Line Interface
101 ----------------------
102
103 To improve portability use fsync instead of fdatasync in
104 `notmuch-dump`. There should be no functional difference.
105
106 Library changes
107 ---------------
108
109 Resurrect support for single-message mbox files
110
111   The removal introduced a bug with previously indexed single-message
112   mboxes.  This support remains deprecated.
113
114 Fix for phrase indexing
115
116   There were several bugs where words intermingled from different
117   headers and MIME parts could match a single phrase query.  This fix
118   will affect only newly indexed messages.
119
120 Emacs Interface
121 ---------------
122
123 Make sure tagging on an empty query is harmless
124
125   Previously tagging an empty query could lead to tags being
126   unintentionally removed.
127
128 Notmuch 0.18 (2014-05-06)
129 =========================
130
131 Overview
132 --------
133
134 This new release includes some enhancements to searching for messages
135 by filesystem location (`folder:` and `path:` prefixes under *General*
136 below).  Saved searches in *Emacs* have also been enhanced to allow
137 distinct search orders for each one.  Another enhancement to the
138 *Emacs* interface is that replies to encrypted messages are now
139 encrypted, reducing the risk of unintentional information disclosure.
140 The default dump output format has changed to the more robust
141 `batch-tag` format. The previously deprecated parsing of single
142 message mboxes has been removed. For detailed release notes, see
143 below.
144
145 General
146 -------
147
148 The `folder:` search prefix now requires an exact match
149
150   The `folder:` prefix has been changed to search for email messages
151   by the exact, case sensitive maildir or MH folder name. Wildcard
152   matching (`folder:foo*`) is no longer supported. The new behaviour
153   allows for more accurate mail folder based searches, makes it
154   possible to search for messages in the top-level folder, and should
155   lead to less surprising results than the old behaviour. Users are
156   advised to see the `notmuch-search-terms` manual page for details,
157   and review how the change affects their existing `folder:` searches.
158
159 There is a new `path:` search prefix.
160
161   The new `path:` search prefix complements the `folder:` prefix. The
162   `path:` prefix searches for email messages that are in particular
163   directories within the mail store, optionally recursively using a
164   special syntax. See the `notmuch-search-terms` manual page for
165   details.
166
167 Notmuch database upgrade due to `folder:` and `path:` changes
168
169   The above mentioned changes to the `folder:` prefix and the addition
170   of `path:` prefix require a Notmuch database upgrade. This will be
171   done automatically, without prompting on the next time `notmuch new`
172   is run after the upgrade. The upgrade is not reversible, and the
173   upgraded database will not be readable by older versions of
174   Notmuch. As a safeguard, a database dump will be created in the
175   `.notmuch` directory before upgrading.
176
177 Library changes
178 ---------------
179
180 Notmuch database upgrade
181
182   The libnotmuch consumers are reminded to handle database upgrades
183   properly, either by relying on running `notmuch new`, or checking
184   `notmuch_database_needs_upgrade()` and calling
185   `notmuch_database_upgrade()` as necessary. This has always been the
186   case, but in practise there have been no database upgrades in any
187   released version of Notmuch before now.
188
189 Support for indexing mbox files has been dropped
190
191   There has never been proper support for mbox files containing
192   multiple messages, and the support for single-message mbox files has
193   been deprecated since Notmuch 0.15. The support has now been
194   dropped, and all mbox files will be rejected during indexing.
195
196 Message header parsing changes
197
198   Notmuch previously had an internal parser for message headers. The
199   parser has now been dropped in favour of letting GMime parse both
200   the headers and the message MIME structure at the same pass. This is
201   mostly an internal change, but the GMime parser is stricter in its
202   interpretation of the headers. This may result in messages with
203   slightly malformed message headers being now rejected.
204
205 Command-Line Interface
206 ----------------------
207
208 `notmuch dump` now defaults to `batch-tag` format
209
210   The old format is still available with `--format=sup`.
211
212 `notmuch new` has a --quiet option
213
214   This option suppresses the progress and summary reports.
215
216 `notmuch insert` respects maildir.synchronize_flags config option
217
218   Do not synchronize tags to maildir flags in `notmuch insert` if the
219   user does not want it.
220
221 The commands set consistent exit status codes on failures
222
223   The cli commands now consistently set exit status of 1 on failures,
224   except where explicitly otherwise noted. The notable expections are
225   the status codes for format version mismatches for commands that
226   support formatted output.
227
228 Bug fix for checking configured new.tags for invalid tags
229
230   `notmuch new` and `notmuch insert` now check the user configured
231   new.tags for invalid tags, and refuse to apply them, similar to
232   `notmuch tag`. Invalid tags are currently the empty string and tags
233   starting with `-`.
234
235 Emacs Interface
236 ---------------
237
238 Init file
239
240   If the file pointed by new variable `notmuch-init-file` (typically
241   `~/.emacs.d/notmuch-config.el`) exists, it is loaded at the end of
242   `notmuch.el`. Users can put their personal notmuch emacs lisp based
243   configuration/customization items there instead of filling
244   `~/.emacs` with these.
245
246 Changed format for saved searches
247
248   The format for `notmuch-saved-searches` has changed, but old style
249   saved searches are still supported. The new style means that a saved
250   search can store the desired sort order for the search, and it can
251   store a separate query to use for generating the count notmuch
252   shows.
253
254   The variable is fully customizable and any configuration done
255   through customize should *just work*, with the additional options
256   mentioned above. For manual customization see the documentation for
257   `notmuch-saved-searches`.
258
259   IMPORTANT: a new style notmuch-saved-searches variable will break
260   previous versions of notmuch-emacs (even search will not work); to
261   fix remove the customization for notmuch-saved-searches.
262
263   If you have a custom saved search sort function (not unsorted or
264   alphabetical) then the sort function will need to be
265   modified. Replacing (car saved-search) by (notmuch-saved-search-get
266   saved-search :name) and (cdr saved-search) by
267   (notmuch-saved-search-get saved-search :query) should be sufficient.
268
269 The keys of `notmuch-tag-formats` are now regexps
270
271   Previously, the keys were literal strings.  Customized settings of
272   `notmuch-tag-formats` will continue to work as before unless tags
273   contain regexp special characters like `.` or `*`.
274
275 Changed tags are now shown in the buffer
276
277   Previously tag changes made in a buffer were shown immediately. In
278   some cases (particularly automatic tag changes like marking read)
279   this made it hard to see what had happened (e.g., whether the
280   message had been unread).
281
282   The changes are now shown explicitly in the buffer: by default
283   deleted tags are displayed with red strike-through and added tags
284   are displayed underlined in green (inverse video is used for deleted
285   tags if the terminal does not support strike-through).
286
287   The variables `notmuch-tag-deleted-formats` and
288   `notmuch-tag-added-formats`, which have the same syntax as
289   `notmuch-tag-formats`, allow this to be customized.
290
291   Setting `notmuch-tag-deleted-formats` to `'((".*" nil))` and
292   `notmuch-tag-added-formats` to `'((".*" tag))` will give the old
293   behavior of hiding deleted tags and showing added tags identically
294   to tags already present.
295
296 Version variable
297
298   The new, build-time generated variable `notmuch-emacs-version` is used
299   to distinguish between notmuch cli and notmuch emacs versions.
300   The function `notmuch-hello-versions` (bound to 'v' in notmuch-hello
301   window) prints both notmuch cli and notmuch emacs versions in case
302   these differ from each other.
303   This is especially useful when using notmuch remotely.
304
305 Ido-completing-read initialization in Emacs 23
306
307   `ido-completing-read` in Emacs 23 versions 1 through 3 freezes unless
308   it is initialized. Defadvice-based *Ido* initialization is defined
309   for these Emacs versions.
310
311 Bug fix for saved searches with newlines in them
312
313   Split lines confuse `notmuch count --batch`, so we remove embedded
314   newlines before calling notmuch count.
315
316 Bug fixes for sender identities
317
318   Previously, Emacs would rewrite some sender identities in unexpected
319   and undesirable ways.  Now it will use identities exactly as
320   configured in `notmuch-identities`.
321
322 Replies to encrypted messages will be encrypted by default
323
324   In the interest of maintaining confidentiality of communications,
325   the Notmuch Emacs interface now automatically adds the mml tag to
326   encrypt replies to encrypted messages. This should make it less
327   likely to accidentally reply to encrypted messages in plain text.
328
329 Reply pushes mark before signature
330
331   We push mark and set point on reply so that the user can easily cut
332   the quoted text. The mark is now pushed before the signature, if
333   any, instead of end of buffer so the signature is preserved.
334
335 Message piping uses the originating buffer's working directory
336
337   `notmuch-show-pipe-message` now uses the originating buffer's
338   current default directory instead of that of the `*notmuch-pipe*`
339   buffer's.
340
341 nmbug
342 -----
343
344 nmbug adds a `clone` command for setting up the initial repository and
345 uses `@{upstream}` instead of `FETCH_HEAD` to track upstream changes.
346
347   The `@{upstream}` change reduces ambiguity when fetching multiple
348   branches, but requires existing users update their `NMBGIT`
349   repository (usually `~/.nmbug`) to distinguish between local and
350   remote-tracking branches.  The easiest way to do this is:
351
352   1. If you have any purely local commits (i.e. they aren't in the
353      nmbug repository on nmbug.tethera.net), push them to a remote
354      repository.  We'll restore them from the backup in step 4.
355   2. Remove your `NMBGIT` repository (e.g. `mv .nmbug .nmbug.bak`).
356   3. Use the new `clone` command to create a fresh clone:
357
358         nmbug clone http://nmbug.tethera.net/git/nmbug-tags.git
359
360   4. If you had local commits in step 1, add a remote for that
361      repository and fetch them into the new repository.
362
363 Notmuch 0.17 (2013-12-30)
364 =========================
365
366 Incompatible change in SHA1 computation
367 ---------------------------------------
368
369 Previously on big endian architectures like sparc and powerpc the
370 computation of SHA1 hashes was incorrect. This meant that messages
371 with overlong or missing message-ids were given different computed
372 message-ids than on more common little endian architectures like i386
373 and amd64.  If you use notmuch on a big endian architecture, you are
374 strongly advised to make a backup of your tags using `notmuch dump`
375 before this upgrade. You can locate the affected files using something
376 like:
377
378     notmuch dump | \
379       awk '/^notmuch-sha1-[0-9a-f]{40} / \
380         {system("notmuch search --exclude=false --output=files id:" $1)}'
381
382 Command-Line Interface
383 ----------------------
384
385 New options to better support handling duplicate messages
386
387   If more than one message file is associated with a message-id,
388   `notmuch search --output=files` will print all of them. A new
389   `--duplicate=N` option can be used to specify which duplicate to
390   print for each message.
391
392   `notmuch count` now supports `--output=files` option to output the
393   number of files associated with matching messages. This may be
394   bigger than the number of matching messages due to duplicates
395   (i.e. multiple files having the same message-id).
396
397 Improved `notmuch new` performance for unchanged folders
398
399   `notmuch new` now skips over unchanged folders more efficiently,
400   which can substantially improve the performance of checking for new
401   mail in some situations (like NFS-mounted Maildirs).
402
403 `notmuch reply --format=text` RFC 2047-encodes headers
404
405   Previously, this used a mix of standard MIME encoding for the reply
406   body and UTF-8 for the headers.  Now, the text format reply template
407   RFC 2047-encodes the headers, making the output a valid RFC 2822
408   message.  The JSON/sexp format is unchanged.
409
410 `notmuch compact` command
411
412   The new `compact` command exposes Xapian's compaction
413   functionality through a more convenient interface than
414   `xapian-compact`. `notmuch compact` will compact the database to a
415   temporary location, optionally backup the original database, and
416   move the compacted database into place.
417
418 Emacs Interface
419 ---------------
420
421 `notmuch-tree` (formerly `notmuch-pick`) has been added to mainline
422
423   `notmuch-tree` is a threaded message view for the emacs
424   interface. Each message is one line in the results and the thread
425   structure is shown using UTF-8 box drawing characters (similar to
426   Mutt's threaded view). It comes between search and show in terms of
427   amount of output and can be useful for viewing both single threads
428   and multiple threads.
429
430   Using `notmuch-tree`
431
432   The main key entries to notmuch tree are
433
434   'z' enter a query to view using notmuch tree (works in hello,
435       search, show and tree mode itself)
436
437   'Z' view the current query in tree notmuch tree (works from search
438       and show)
439
440   Once in tree mode, keybindings are mostly in line with the rest of
441   notmuch and are all viewable with '?' as usual.
442
443   Customising `notmuch-tree`
444
445   `notmuch-tree` has several customisation variables. The most
446   significant is the first notmuch-tree-show-out which determines the
447   behaviour when selecting a message (with RET) in tree view. By
448   default tree view uses a split window showing the single message in
449   the bottom pane. However, if this option is set then it views the
450   whole thread in the complete window jumping to the selected message
451   in the thread. In either case command-prefix selects the other option.
452
453 Tagging threads in search is now race-free
454
455   Previously, adding or removing a tag from a thread in a search
456   buffer would affect messages that had arrived after the search was
457   performed, resulting in, for example, archiving messages that were
458   never seen.  Tagging now affects only the messages that were in the
459   thread when the search was performed.
460
461 `notmuch-hello` refreshes when switching to the buffer
462
463   The hello buffer now refreshes whenever you switch to the buffer,
464   regardless of how you get there.  You can disable automatic
465   refreshing by customizing `notmuch-hello-auto-refresh`.
466
467 Specific mini-buffer prompts for tagging operations
468
469   When entering tags to add or remove, the mini-buffer prompt now
470   indicates what operation will be performed (e.g., "Tag thread", "Tag
471   message", etc).
472
473 Built-in help improvements
474
475   Documentation for many commands has been improved, as displayed by
476   `notmuch-help` (usually bound to "?").  The bindings listed by
477   `notmuch-help` also now include descriptions of prefixed commands.
478
479 Quote replies as they are displayed in show view
480
481   We now render the parts for reply quoting the same way they are
482   rendered for show. At this time, the notable change is that replies
483   to text/calendar are now pretty instead of raw vcalendar.
484
485 Fixed inconsistent use of configured search order
486
487   All ways of interactively invoking search now honor the value of
488   `notmuch-search-oldest-first`.
489
490 Common keymap for notmuch-wide bindings
491
492   Several key bindings have been moved from mode-specific keymaps to
493   the single `notmuch-common-keymap`, which is inherited by each
494   notmuch mode.  If you've customized your key bindings, you may want
495   to move some of them to the common keymap.
496
497 The `notmuch-tag` function now requires a list of tag changes
498
499   For users who have scripted the Emacs interface: the `notmuch-tag`
500   API has changed.  Previously, it accepted either a list of tag
501   changes or a space-separated string of tag changes.  The latter is
502   no longer supported and the function now returns nothing.
503
504 Fixed `notmuch-reply` putting reply in primary selection
505
506   On emacs 24 notmuch-reply used to put the cited text into the
507   primary selection (which could lead to inadvertently pasting this
508   cited text elsewhere). Now the primary-selection is not changed.
509
510 Fixed `notmuch-show` invisible part handling
511
512   In some obscure cases part buttons and invisibility had strange
513   interactions: in particular, the default action for some parts gave
514   the wrong action. This has been fixed.
515
516 Fixed `notmuch-show` attachment viewers and stderr
517
518   In emacs 24.3+ viewing an attachment could cause spurious text to
519   appear in the show buffer (any stderr or stdout the viewer
520   produced). By default this output is now discarded. For debugging,
521   setting `notmuch-show-attachment-debug` causes notmuch to keep the
522   viewer's stderr and stdout in a separate buffer.
523
524 Fixed `notmuch-mua-reply` point placement when signature involved
525
526   By restricting cursor movement to body section for cursor placement
527   after signature is inserted, the cursor cannot "leak" to header
528   section anymore. Now inserted citation content will definitely go to
529   the body part of the message.
530
531 Vim Interface
532 -------------
533
534   It is now possible to compose new messages in the Vim interface, as
535   opposed reply to existing messages.  There is also support for
536   going straight to a search (bypassing the folders view).
537
538 Notmuch 0.16 (2013-08-03)
539 =========================
540
541 Command-Line Interface
542 ----------------------
543
544 Support for delivering messages to Maildir
545
546   There is a new command `insert` that adds a message to a Maildir
547   folder and notmuch index.
548
549 `notmuch count --batch` option
550
551   `notmuch count` now supports batch operations similar to `notmuch
552   tag`. This is mostly an optimization for remote notmuch usage.
553
554 `notmuch tag` option to remove all tags from matching messages
555
556   `notmuch tag --remove-all` option has been added to remove all tags
557   from matching messages. This can be combined with adding new tags,
558   resulting in setting (rather than modifying) the tags of the
559   messages.
560
561 Decrypting commands explicitly expect a gpg-agent
562
563   Decryption in `notmuch show` and `notmuch reply` has only ever
564   worked with a functioning gpg-agent. This is now made explicit in
565   code and documentation. The functional change is that it's now
566   possible to have gpg-agent running, but gpg "use-agent"
567   configuration option disabled, not forcing the user to use the agent
568   everywhere.
569
570 Configuration file saves follow symbolic links
571
572   The notmuch commands that save the configuration file now follow
573   symbolic links instead of overwrite them.
574
575 Top level option to specify configuration file
576
577   It's now possible to specify the configuration file to use on the
578   command line using the `notmuch --config=FILE` option.
579
580 Bash command-line completion
581
582   The notmuch command-line completion support for the bash shell has
583   been rewritten. Supported completions include all the notmuch
584   commands, command-line arguments, values for keyword arguments,
585   search prefixes (such as "subject:" or "from:") in all commands that
586   use search terms, tags after + and - in `notmuch tag`, tags after
587   "tag:" prefix, user's email addresses after "from:" and "to:"
588   prefixes, and config options (and some config option values) in
589   `notmuch config`. The new completion support depends on the
590   bash-completion package.
591
592 Deprecated commands "part" and "search-tags" are removed.
593
594 Emacs Interface
595 ---------------
596
597 New keymap to view/save parts; removed s/v/o/| part button bindings
598
599   The commands to view, save, and open MIME parts are now prefixed
600   with "." (". s" to save, ". v" to view, etc) and can be invoked with
601   point anywhere in a part, unlike the old commands, which were
602   restricted to part buttons.  The old "s"/"v"/"o"/"|" commands on
603   part buttons have been removed since they clashed with other
604   bindings (notably "s" for search!) and could not be invoked when
605   there was no part button.  The new, prefixed bindings appear in
606   show's help, so you no longer have to memorize them.
607
608 Default part save directory is now `mm-default-directory`
609
610   Previously, notmuch offered to save parts and attachments to a mix
611   of `mm-default-directory`, `mailcap-download-directory`, and `~/`.
612   This has been standardized on `mm-default-directory`.
613
614 Key bindings for next/previous thread
615
616   Show view has new key bindings M-n and M-p to move to the next and
617   previous thread in the search results.
618
619 Better handling of errors in search buffers
620
621   Instead of interleaving errors in search result buffers, search mode
622   now reports errors in the minibuffer.
623
624 Faster search and show
625
626   Communication between Emacs and the notmuch CLI is now more
627   efficient because it uses the CLI's S-expression support.  As a
628   result, search mode should now fill search buffers faster and
629   threads should show faster.
630
631 No Emacs 22 support
632
633   The Emacs 22 support added late 2010 was sufficient only for a short
634   period of time. After being incomplete for roughly 2 years the code
635   in question was now removed from this release.
636
637 Vim Front-End
638 -------------
639
640 The vim based front-end has been replaced with a new one that uses the Ruby
641 bindings. The old font-end is available in the contrib subfolder.
642
643 Python Bindings
644 ---------------
645
646 Fix loading of libnotmuch shared library on OS X (Darwin) systems.
647
648 Notmuch 0.15.2 (2013-02-17)
649 ===========================
650
651 Build fixes
652 -----------
653
654 Update dependencies to avoid problems when building in parallel.
655
656 Internal test framework changes
657 -------------------------------
658
659 Adjust Emacs test watchdog mechanism to cope with `process-attributes`
660 being unimplemented.
661
662 Notmuch 0.15.1 (2013-01-24)
663 ===========================
664
665 Internal test framework changes
666 -------------------------------
667
668 Set a default value for TERM when running tests. This fixes certain
669 build failures in non-interactive environments.
670
671 Notmuch 0.15 (2013-01-18)
672 =========================
673
674 General
675 -------
676
677 Date range search support
678
679   The `date:` prefix can now be used in queries to restrict the results
680   to only messages within a particular time range (based on the Date:
681   header) with a range syntax of `date:<since>..<until>`. Notmuch
682   supports a wide variety of expressions in `<since>` and
683   `<until>`. Please refer to the `notmuch-search-terms(7)` manual page
684   for details.
685
686 Empty tag names and tags beginning with "-" are deprecated
687
688   Such tags have been a frequent source of confusion and cause
689   (sometimes unresolvable) conflicts with other syntax.  notmuch tag
690   no longer allows such tags to be added to messages.  Removing such
691   tags continues to be supported to allow cleanup of existing tags,
692   but may be removed in a future release.
693
694 Command-Line Interface
695 ----------------------
696
697 `notmuch new` no longer chokes on mboxes
698
699   `notmuch new` now rejects mbox files containing more than one
700   message, rather than treating the file as one giant message.
701
702 Support for single message mboxes is deprecated
703
704   For historical reasons, `notmuch new` will index mbox files
705   containing a single message; however, this behavior is now
706   officially deprecated.
707
708 Fixed `notmuch new` to skip ignored broken symlinks
709
710   `notmuch new` now correctly skips symlinks if they are in the
711   ignored files list.  Previously, it would abort when encountering
712   broken symlink, even if it was ignored.
713
714 New dump/restore format and tagging interface
715
716   There is a new `batch-tag` format for dump and restore that is more
717   robust, particularly with respect to tags and message-ids containing
718   whitespace.
719
720   `notmuch tag` now supports the ability to read tag operations and
721   queries from an input stream, in a format compatible with the new
722   dump/restore format.
723
724 Bcc and Reply-To headers are now available in notmuch show json output
725
726   The `notmuch show --format=json` now includes "Bcc" and "Reply-To" headers.
727   For example notmuch Emacs client can now have these headers visible
728   when the headers are added to the `notmuch-message-headers` variable.
729
730 CLI callers can now request a specific output format version
731
732   `notmuch` subcommands that support structured output now support a
733   `--format-version` argument for requesting a specific version of the
734   structured output, enabling better compatibility and error handling.
735
736 `notmuch search` has gained a null character separated text output format
737
738   The new --format=text0 output format for `notmuch search` prints
739   output separated by null characters rather than newline
740   characters. This is similar to the find(1) -print0 option, and works
741   together with the xargs(1) -0 option.
742
743 Emacs Interface
744 ---------------
745
746 Removal of the deprecated `notmuch-folders` variable
747
748   `notmuch-folders` has been deprecated since the introduction of saved
749   searches and the notmuch hello view in notmuch 0.3. `notmuch-folders`
750   has now been removed. Any remaining users should migrate to
751   `notmuch-saved-searches`.
752
753 Visibility of MIME parts can be toggled
754
755   Each part of a multi-part MIME email can now be shown or hidden
756   using the button at the top of each part (by pressing RET on it or
757   by clicking).  For emails with multiple alternative formats (e.g.,
758   plain text and HTML), only the preferred format is shown initially,
759   but other formats can be shown using their part buttons.  To control
760   the behavior of this, see
761   `notmuch-multipart/alternative-discouraged` and
762   `notmuch-show-all-multipart/alternative-parts`.
763
764   Note notmuch-show-print-message (bound to '#' by default) will print
765   all parts of multipart/alternative message regardless of whether
766   they are currently hidden or shown in the buffer.
767
768 Emacs now buttonizes mid: links
769
770   mid: links are a standardized way to link to messages by message ID
771   (see RFC 2392).  Emacs now hyperlinks mid: links to the appropriate
772   notmuch search.
773
774 Handle errors from bodypart insertions
775
776   If displaying the text of a message in show mode causes an error (in
777   the `notmuch-show-insert-part-*` functions), notmuch no longer cuts
778   off thread display at the offending message.  The error is now
779   simply displayed in place of the message.
780
781 Emacs now detects version mismatches with the notmuch CLI
782
783   Emacs now detects and reports when the Emacs interface version and
784   the notmuch CLI version are incompatible.
785
786 Improved text/calendar content handling
787
788   Carriage returns in embedded text/calendar content caused insertion
789   of the calendar content fail. Now CRs are removed before calling icalendar
790   to extract icalendar data. In case icalendar extraction fails an error
791   is thrown for the bodypart insertion function to deal with.
792
793 Disabled coding conversions when reading in `with-current-notmuch-show-message`
794
795   Depending on the user's locale, saving attachments containing 8-bit
796   data may have performed an unintentional encoding conversion,
797   corrupting the saved attachment.  This has been fixed by making
798   `with-current-notmuch-show-message` disable coding conversion.
799
800 Fixed errors with HTML email containing images in Emacs 24
801
802   Emacs 24 ships with a new HTML renderer that produces better output,
803   but is slightly buggy.  We work around a bug that caused it to fail
804   for HTML email containing images.
805
806 Fixed handling of tags with unusual characters in them
807
808   Emacs now handles tags containing spaces, quotes, and parenthesis.
809
810 Fixed buttonization of id: links without quote characters
811
812   Emacs now correctly buttonizes id: links where the message ID is not
813   quoted.
814
815 `notmuch-hello` refresh point placement improvements
816
817   Refreshing the `notmuch-hello` buffer does a better job of keeping
818   the point where it was.
819
820 Automatic tag changes are now unified and customizable
821
822   All the automatic tag changes that the Emacs interface makes when
823   reading, archiving, or replying to messages, can now be
824   customized. Any number of tag additions and removals is supported
825   through the `notmuch-show-mark-read`, `notmuch-archive-tags`, and
826   `notmuch-message-replied-tags` customization variables.
827
828 Support for stashing the thread id in show view
829
830   Invoking `notmuch-show-stash-message-id` with a prefix argument
831   stashes the (local and database specific) thread id of the current
832   thread instead of the message id.
833
834 New add-on tool: notmuch-pick
835 -----------------------------
836
837 The new contrib/ tool `notmuch-pick` is an experimental threaded message
838 view for the emacs interface. Each message is one line in the results
839 and the thread structure is shown using UTF-8 box drawing characters
840 (similar to Mutt's threaded view). It comes between search and show in
841 terms of amount of output and can be useful for viewing both single
842 threads and multiple threads. See the notmuch-pick README file for
843 further details and installation.
844
845 Portability
846 -----------
847
848 notmuch now builds on OpenBSD.
849
850 Internal test framework changes
851 -------------------------------
852
853 The emacsclient binary is now user-configurable
854
855   The test framework now accepts `TEST_EMACSCLIENT` in addition to
856   `TEST_EMACS` for configuring the emacsclient to use.  This is
857   necessary to avoid using an old emacsclient with a new emacs, which
858   can result in buggy behavior.
859
860 Notmuch 0.14 (2012-08-20)
861 =========================
862
863 General bug fixes
864 -----------------
865
866 Maildir tag synchronization
867
868   Maildir flag-to-tag synchronization now applies only to messages in
869   maildir-like directory structures.  Previously, it applied to any
870   message that had a maildir "info" part, which meant it could
871   incorrectly synchronize tags for non-maildir messages, while at the
872   same time failing to synchronize tags for newly received maildir
873   messages (typically causing new messages to not receive the "unread"
874   tag).
875
876 Command-Line Interface
877 ----------------------
878
879   The deprecated positional output file argument to `notmuch dump` has
880   been replaced with an `--output` option. The input file positional
881   argument to `notmuch restore` has been replaced with an `--input`
882   option for consistency with dump.  These changes simplify the syntax
883   of dump/restore options and make them more consistent with other
884   notmuch commands.
885
886 Emacs Interface
887 ---------------
888
889 Search results now get re-colored when tags are updated
890
891 The formatting of tags in search results can now be customized
892
893   Previously, attempting to change the format of tags in
894   `notmuch-search-result-format` would usually break tagging from
895   search-mode.  We no longer make assumptions about the format.
896
897 Experimental support for multi-line search result formats
898
899   It is now possible to embed newlines in
900   `notmuch-search-result-format` to make individual search results
901   span multiple lines.
902
903 Next/previous in search and show now move by boundaries
904
905   All "next" and "previous" commands in the search and show modes now
906   move to the next/previous result or message boundary.  This doesn't
907   change the behavior of "next", but "previous" commands will first
908   move to the beginning of the current result or message if point is
909   inside the result or message.
910
911 Search now uses the JSON format internally
912
913   This should address problems with unusual characters in authors and
914   subject lines that could confuse the old text-based search parser.
915
916 The date shown in search results is no longer padded before applying
917 user-specified formatting
918
919   Previously, the date in the search results was padded to fixed width
920   before being formatted with `notmuch-search-result-format`.  It is
921   no longer padded.  The default format has been updated, but if
922   you've customized this variable, you may have to change your date
923   format from `"%s "` to `"%12s "`.
924
925 The thread-id for the `target-thread` argument for `notmuch-search` should
926 now be supplied without the "thread:" prefix.
927
928 Notmuch 0.13.2 (2012-06-02)
929 ===========================
930
931 Bug-fix release
932 ---------------
933
934 Update `contrib/notmuch-deliver` for API changes in 0.13. This fixes a
935 compilation error for this contrib package.
936
937 Notmuch 0.13.1 (2012-05-29)
938 ===========================
939
940 Bug-fix release
941 ---------------
942
943 Fix inserting of UTF-8 characters from *text/plain* parts in reply
944
945   While notmuch gained ability to insert content from other than *text/plain*
946   parts of email whenever *text/plain* parts are not available (notably
947   HTML-only emails), replying to mails that do have *text/plain* the
948   non-ASCII characters were incorrectly decoded. This is now fixed.
949
950 `notmuch_database_get_directory` and
951 `notmuch_database_find_message_by_filename` now work on read-only
952 databases
953
954   Previously, these functions attempted to create directory documents
955   that didn't exist and would return an error or abort when given a
956   read-only database.  Now they no longer create directory documents
957   and simply return a `NULL` object if the directory does not exist,
958   as documented.
959
960 Fix compilation of ruby bindings
961
962   Revert to dynamic linking, since the statically linked bindings did
963   not work well.
964
965 Notmuch 0.13 (2012-05-15)
966 =========================
967
968 Command-Line Interface
969 ----------------------
970
971 JSON reply format
972
973   `notmuch reply` can now produce JSON output that contains the headers
974   for a reply message and full information about the original message
975   begin replied to. This allows MUAs to create replies intelligently.
976   For example, an MUA that can parse HTML might quote HTML parts.
977
978   Calling notmuch reply with `--format=json` imposes the restriction that
979   only a single message is returned by the search, as replying to
980   multiple messages does not have a well-defined behavior. The default
981   retains its current behavior for multiple message replies.
982
983 Tag exclusion
984
985   Tags can be automatically excluded from search results by adding them
986   to the new `search.exclude_tags` option in the Notmuch config file.
987
988   This behaviour can be overridden by explicitly including an excluded
989   tag in your query, for example:
990
991         notmuch search $your_query and tag:$excluded_tag
992
993   Existing users will probably want to run `notmuch setup` again to add
994   the new well-commented [search] section to the configuration file.
995
996   For new configurations, accepting the default setting will cause the
997   tags "deleted" and "spam" to be excluded, equivalent to running:
998
999         notmuch config set search.exclude_tags deleted spam
1000
1001 Raw show format changes
1002
1003   The output of show `--format=raw` has changed for multipart and
1004   message parts.  Previously, the output was a mash of somewhat-parsed
1005   headers and transfer-decoded bodies.  Now, such parts are reproduced
1006   faithfully from the original source.  Message parts (which includes
1007   part 0) output the full message, including the message headers (but
1008   not the transfer headers).  Multipart parts output the part as
1009   encoded in the original message, including the part's headers.  Leaf
1010   parts, as before, output the part's transfer-decoded body.
1011
1012 Listing configuration items
1013
1014   The new `config list` command prints out all configuration items and
1015   their values.
1016
1017 Emacs Interface
1018 ---------------
1019
1020 Changes to tagging interface
1021
1022   The user-facing tagging functions in the Emacs interface have been
1023   normalized across all notmuch modes.  The tagging functions are now
1024   notmuch-search-tag in search-mode, and notmuch-show-tag in
1025   show-mode.  They accept a string representing a single tag change,
1026   or a list of tag changes.  See 'M-x describe-function notmuch-tag'
1027   for more information.
1028
1029   NOTE: This breaks compatibility with old tagging functions, so user
1030   may need to update in custom configurations.
1031
1032 Reply improvement using the JSON format
1033
1034   Emacs now uses the JSON reply format to create replies. It obeys
1035   the customization variables message-citation-line-format and
1036   message-citation-line-function when creating the first line of the
1037   reply body, and it will quote HTML parts if no text/plain parts are
1038   available.
1039
1040 New add-on tool: notmuch-mutt
1041 -----------------------------
1042
1043 The new contrib/ tool `notmuch-mutt` provides Notmuch integration for
1044 the Mutt mail user agent. Using it, Mutt users can perform mail
1045 search, thread reconstruction, and mail tagging/untagging without
1046 leaving Mutt.  notmuch-mutt, formerly distributed under the name
1047 `mutt-notmuch` by Stefano Zacchiroli, will be maintained as a notmuch
1048 contrib/ from now on.
1049
1050 Library changes
1051 ---------------
1052
1053 The API changes detailed below break binary and source compatibility,
1054 so libnotmuch has been bumped to version 3.0.0.
1055
1056 The function `notmuch_database_close` has been split into
1057 `notmuch_database_close` and `notmuch_database_destroy`
1058
1059   This makes it possible for long running programs to close the xapian
1060   database and thus release the lock associated with it without
1061   destroying the data structures obtained from it.
1062
1063 `notmuch_database_open`, `notmuch_database_create`, and
1064 `notmuch_database_get_directory` now return errors
1065
1066   The type signatures of these functions have changed so that the
1067   functions now return a `notmuch_status_t` and take an out-argument for
1068   returning the new database object or directory object.
1069
1070 Go bindings changes
1071 -------------------
1072
1073 Go 1 compatibility
1074
1075   The go bindings and the `notmuch-addrlookup` utility are now
1076   compatible with go 1.
1077
1078 Notmuch 0.12 (2012-03-20)
1079 =========================
1080
1081 Command-Line Interface
1082 ----------------------
1083
1084 Reply to sender
1085
1086   `notmuch reply` has gained the ability to create a reply template
1087   for replying just to the sender of the message, in addition to reply
1088   to all. The feature is available through the new command line option
1089   `--reply-to=(all|sender)`.
1090
1091 Mail store folder/file ignore
1092
1093   A new configuration option, `new.ignore`, lets users specify a
1094   ;-separated list of file and directory names that will not be
1095   searched for messages by `notmuch new`.
1096
1097   NOTE: *Every* file/directory that goes by one of those names will
1098   be ignored, independent of its depth/location in the mail store.
1099
1100 Unified help and manual pages
1101
1102   The notmuch help command now runs man for the appropriate page.  If
1103   you install notmuch somewhere "unusual", you may need to update
1104   MANPATH.
1105
1106 Manual page for notmuch configuration options
1107
1108   The notmuch CLI configuration file options are now documented in the
1109   notmuch-config(1) manual page in addition to the configuration file
1110   itself.
1111
1112 Emacs Interface
1113 ---------------
1114
1115 Reply to sender
1116
1117   The Emacs interface has, with the new CLI support, gained the
1118   ability to reply to sender in addition to reply to all. In both show
1119   and search modes, 'r' has been bound to reply to sender, replacing
1120   reply to all, which now has key binding 'R'.
1121
1122 More flexible and consistent tagging operations
1123
1124   All tagging operations ('+', '-', '*') now accept multiple tags with
1125   '+' or '-' prefix, like '*' operation in notmuch-search view before.
1126
1127   '*' operation (`notmuch-show-tag-all`) is now available in
1128   notmuch-show view.
1129
1130   `notmuch-show-{add,remove}-tag` functions no longer accept tag
1131   argument, `notmuch-show-tag-message` should be used instead.  Custom
1132   bindings using these functions should be updated, e.g.:
1133
1134         (notmuch-show-remove-tag "unread")
1135
1136   should be changed to:
1137
1138         (notmuch-show-tag-message "-unread")
1139
1140 Refreshing the show view ('=' by default) no longer opens or closes messages
1141
1142   To get the old behavior of putting messages back in their initial
1143   opened/closed state, use a prefix argument, e.g., 'C-u ='.
1144
1145 Attachment buttons can be used to view or save attachments.
1146
1147   When the cursor is on an attachment button the key 's' can be used
1148   to save the attachment, the key 'v' to view the attachment in the
1149   default mailcap application, and the key 'o' prompts the user for an
1150   application to use to open the attachment. By default Enter or mouse
1151   button 1 saves the attachment but this is customisable (option
1152   Notmuch Show Part Button Default Action).
1153
1154 New functions
1155
1156   `notmuch-show-stash-mlarchive-link{,-and-go}` allow stashing and
1157   optionally visiting a URI to the current message at one of a number
1158   of Mailing List Archives.
1159
1160 Fix MML tag quoting in replies
1161
1162   The MML tag quoting fix of 0.11.1 unintentionally quoted tags
1163   inserted in `message-setup-hook`. Quoting is now limited to the
1164   cited message.
1165
1166 Show view archiving key binding changes
1167
1168   The show view archiving key bindings 'a' and 'x' now remove the
1169   "inbox" tag from the current message only (instead of thread), and
1170   move to the next message. At the last message, 'a' proceeds to the
1171   next thread in search results, and 'x' returns to search
1172   results. The thread archiving functions are now available in 'A' and
1173   'X'.
1174
1175 Support text/calendar MIME type
1176
1177   The text/calendar MIME type is now supported in addition to
1178   text/x-vcalendar.
1179
1180 Generate inline patch fake attachment file names from message subject
1181
1182   Use the message subject to generate file names for the inline patch
1183   fake attachments. The names are now similar to the ones generated by
1184   'git format-patch' instead of just "inline patch". See "Notmuch Show
1185   Insert Text/Plain Hook" in the notmuch customize interface.
1186
1187 Enable `notmuch-search-line-faces` by default
1188
1189   Make the `notmuch-search-line-faces` functionality more discoverable
1190   for new users by showing "unread" messages bold and "flagged"
1191   messages blue by default in the search view.
1192
1193 Printing Support
1194
1195   notmuch-show mode now has simple printing support, bound to '#' by
1196   default. You can customize the variable notmuch-print-mechanism.
1197
1198 Library changes
1199 ---------------
1200
1201 New functions
1202
1203   `notmuch_query_add_tag_exclude` supports the new tag exclusion
1204   feature.
1205
1206 Python bindings changes
1207 -----------------------
1208
1209 Python 3.2 compatibility
1210
1211   The python bindings are now compatible with both python 2.5+ and 3.2.
1212
1213 Added missing unicode conversions
1214
1215   Python strings have to be encoded to and decoded from utf-8 when
1216   calling libnotmuch functions. Porting the bindings to python 3.2
1217   revealed a few function calls that were missing these conversions.
1218
1219 Build fixes
1220 -----------
1221
1222 Compatibility with GMime 2.6
1223
1224   It is now possible to build notmuch against both GMime 2.4 and 2.6.
1225   However, a bug in GMime 2.6 before 2.6.5 causes notmuch not to
1226   report signatures where the signer key is unavailable (GNOME bug
1227   668085).  For compatibility with GMime 2.4's tolerance of "From "
1228   headers we require GMime 2.6 >= 2.6.7.
1229
1230 Notmuch 0.11.1 (2012-02-03)
1231 ===========================
1232
1233 Bug-fix release
1234 ---------------
1235
1236 Fix error handling in python bindings
1237
1238   The python bindings in 0.11 failed to detect NULL pointers being
1239   returned from libnotmuch functions and thus failed to raise
1240   exceptions to indicate the error condition. Any subsequent calls
1241   into libnotmuch caused segmentation faults.
1242
1243 Quote MML tags in replies
1244
1245   MML tags are text codes that Emacs uses to indicate attachments
1246   (among other things) in messages being composed.  The Emacs
1247   interface did not quote MML tags in the quoted text of a reply.
1248   User could be tricked into replying to a maliciously formatted
1249   message and not editing out the MML tags from the quoted text.  This
1250   could lead to files from the user's machine being attached to the
1251   outgoing message.  The Emacs interface now quotes these tags in
1252   reply text, so that they do not effect outgoing messages.
1253
1254 Notmuch 0.11 (2012-01-13)
1255 =========================
1256
1257 Command-Line Interface
1258 ----------------------
1259
1260 Hooks
1261
1262   Hooks have been introduced to notmuch. Hooks are scripts that notmuch
1263   invokes before and after certain actions. Initially, `notmuch new`
1264   supports `pre-new` and `post-new` hooks that are run before and after
1265   importing new messages into the database.
1266
1267 `notmuch reply --decrypt bugfix`
1268
1269   The `notmuch reply` command with `--decrypt` argument had a rarely
1270   occurring bug that caused an encrypted message not to be decrypted
1271   sometimes. This is now fixed.
1272
1273 Performance
1274 -----------
1275
1276 Automatic tag query optimization
1277
1278   `notmuch tag` now automatically optimizes the user's query to
1279   exclude messages whose tags won't change.  In the past, we've
1280   suggested that people do this by hand; this is no longer necessary.
1281
1282 Don't sort messages when creating a dump file
1283
1284   This speeds up tag dumps considerably, without any loss of
1285   information. To replicate the old behavior of sorted output (for
1286   example to compare two dump files), one can use e.g. `sort(1)`.
1287
1288 Memory Management
1289 -----------------
1290
1291 Reduction of memory leaks
1292
1293   Two memory leaks when searching and showing messages were identified
1294   and fixed in this release.
1295
1296 Emacs Interface
1297 ---------------
1298
1299 Bug fixes
1300
1301   notmuch-show-advance (bound to the spacebar in notmuch-show-mode) had
1302   a bug that caused it to always jump to the next message, even if it
1303   should have scrolled down to show more of the current message instead.
1304   This is now fixed.
1305
1306 Support `notmuch new` as a notmuch-poll-script
1307
1308   It's now possible to use `notmuch new` as a notmuch-poll-script
1309   directly. This is also the new default. This allows taking better
1310   advantage of the `notmuch new` hooks from emacs without intermediate
1311   scripts.
1312
1313 Improvements in saved search management
1314
1315   New saved searches are now appended to the list of saved searches,
1316   not inserted in front. It's also possible to define a sort function
1317   for displaying saved searches; alphabetical sort is provided.
1318
1319 Hooks for notmuch-hello
1320
1321   Two new hooks have been added: "notmuch-hello-mode-hook" (called after
1322   entering notmuch-hello-mode) and "notmuch-hello-refresh-hook" (called
1323   after updating a notmuch-hello buffer).
1324
1325 New face for crypto parts headers
1326
1327   Crypto parts used to be displayed with a hardcoded color. A new face
1328   has been introduced to fix this: notmuch-crypto-part-header. It
1329   defaults to the same value as before, but can be customized to match
1330   other color themes.
1331
1332 Use space as default thousands separator
1333
1334   Large numbers in notmuch-hello are now displayed using a space as
1335   thousands separator (e.g. "123 456" instead of "123,456"). This can be
1336   changed by customizing "notmuch-hello-thousands-separator".
1337
1338 Call notmuch-show instead of notmuch-search when clicking on
1339 buttonized id: links
1340
1341 New function notmuch-show-advance
1342
1343   This new function advances through just the current thread, and is
1344   less invasive than notmuch-show-advance-and-archive.  It can easily
1345   be bound to SPC with:
1346
1347         (define-key notmuch-show-mode-map " " 'notmuch-show-advance)
1348
1349 Various performance improvements
1350
1351 New add-on tool
1352 ---------------
1353
1354 The tool `contrib/notmuch-deliver` helps with initial delivery and
1355 tagging of mail (replacing running `notmuch new`).
1356
1357
1358 Notmuch 0.10.2 (2011-12-04)
1359 ===========================
1360
1361 Bug-fix release
1362 ---------------
1363
1364 Fix crash in python bindings
1365
1366   The python bindings did not call `g_type_init`, which caused crashes
1367   for some, but not all users.
1368
1369 Notmuch 0.10.1 (2011-11-25)
1370 ===========================
1371
1372 Bug-fix release
1373 ---------------
1374
1375 Fix `--help` argument
1376
1377   Argument processing changes in 0.10 introduced a bug where
1378   `notmuch --help` crashed while `notmuch help` worked fine.
1379   This is fixed in 0.10.1.
1380
1381 Notmuch 0.10 (2011-11-23)
1382 =========================
1383
1384 New build and testing features
1385 ------------------------------
1386
1387 Emacs tests are now done in `dtach`. This means that dtach is now
1388 needed to run the notmuch test suite, at least until the checking for
1389 prerequisites is improved.
1390
1391 Full test coverage of the stashing feature in Emacs.
1392
1393 New command-line features
1394 -------------------------
1395
1396 Add `notmuch restore --accumulate` option
1397
1398   The `--accumulate` switch causes the union of the existing and new tags to
1399   be applied, instead of replacing each message's tags as they are read in
1400   from the dump file.
1401
1402 Add search terms to `notmuch dump`
1403
1404   The dump command now takes an optional search term much like notmuch
1405   search/show/tag. The output file argument of dump is deprecated in
1406   favour of using stdout.
1407
1408 Add `notmuch search` `--offset` and `--limit` options
1409
1410   The search command now takes options `--offset=[-]N` and `--limit=N` to
1411   limit the number of results shown.
1412
1413 Add `notmuch count --output` option
1414
1415   The count command is now capable of counting threads in addition to
1416   messages. This is selected using the new `--output=(threads|messages)`
1417   option.
1418
1419 New emacs UI features
1420 ---------------------
1421
1422 Add tab-completion for `notmuch-search` and `notmuch-search-filter`
1423
1424   These functions now support completion tags for query parts
1425   starting with "tag:".
1426
1427 Turn "id:MSG-ID" links into buttons associated with notmuch searches
1428
1429   Text of the form "id:MSG-ID" in mails is now a clickable button that
1430   opens a notmuch search for the given message id.
1431
1432 Add keybinding ('c I') for stashing Message-ID's without an id: prefix
1433
1434   Reduces manual labour when stashing them for use outside notmuch.
1435
1436 Do not query on `notmuch-search` exit
1437
1438   It is harmless to kill the external notmuch process, so the user
1439   is no longer interrogated when they interrupt a search.
1440
1441 Performance
1442 -----------
1443
1444 Emacs now constructs large search buffers more efficiently
1445
1446 Search avoids opening and parsing message files
1447
1448   We now store more information in the database so search no longer
1449   has to open every message file to get basic headers.  This can
1450   improve search speed by as much as 10X, but taking advantage of this
1451   requires a database rebuild:
1452
1453         notmuch dump > notmuch.dump
1454         # Backup, then remove notmuch database ($MAIL/.notmuch)
1455         notmuch new
1456         notmuch restore notmuch.dump
1457
1458 New collection of add-on tools
1459 ------------------------------
1460
1461 The source directory "contrib" contains tools built on notmuch.  These
1462 tools are not part of notmuch, and you should check their individual
1463 licenses.  Feel free to report problems with them to the notmuch
1464 mailing list.
1465
1466 nmbug - share tags with a given prefix
1467
1468   nmbug helps maintain a git repo containing all tags with a given
1469   prefix (by default "notmuch::"). Tags can be shared by commiting
1470   them to git in one location and restoring in another.
1471
1472 Notmuch 0.9 (2011-10-01)
1473 ========================
1474
1475 New, general features
1476 ---------------------
1477
1478 Correct handling of interruptions during `notmuch new`
1479
1480   `notmuch new` now operates as a series of small, self-consistent
1481   transactions, so it can correctly resume after an interruption or
1482   crash.  Previously, interruption could lose existing tags, fail to
1483   detect messages on resume, or leave the database in a state
1484   temporarily or permanently inconsistent with the mail store.
1485
1486 Library changes
1487 ---------------
1488
1489 New functions
1490
1491   `notmuch_database_begin_atomic` and `notmuch_database_end_atomic`
1492   allow multiple database operations to be performed atomically.
1493
1494   `notmuch_database_find_message_by_filename` does exactly what it says.
1495
1496 API changes
1497
1498   `notmuch_database_find_message` (and `n_d_f_m_by_filename`) now return
1499   a status indicator and uses an output parameter for the
1500   message. This change required changing the SONAME of libnotmuch to
1501   libnotmuch.so.2
1502
1503 Python bindings changes
1504 -----------------------
1505
1506   - Re-encode python unicode objects to utf-8 before passing back to
1507     libnotmuch.
1508   - Support `Database().begin_atomic()/end_atomic()`
1509   - Support `Database().find_message_by_filename()`
1510     NB! This needs a db opened in READ-WRITE mode currently, or it will crash
1511     the python process. The is a limitation (=bug) of the underlying libnotmuch.
1512   - Fixes where we would not throw NotmuchErrors when we should (Justus Winter)
1513   - Update for `n_d_find_message*` API changes (see above).
1514
1515 Ruby bindings changes
1516 ---------------------
1517
1518   - Wrap new library functions `notmuch_database_{begin,end}_atomic.`
1519   - Add new exception `Notmuch::UnbalancedAtomicError.`
1520   - Rename destroy to destroy! according to Ruby naming conventions.
1521   - Update for `n_d_find_message*` API changes (see above).
1522
1523 Emacs improvements
1524 ------------------
1525
1526   * Add gpg callback to crypto sigstatus buttons to retrieve/refresh
1527     signing key.
1528   * Add `notmuch-show-refresh-view` function (and corresponding binding)
1529     to refresh the view of a notmuch-show buffer.
1530
1531 Reply formatting cleanup
1532 ------------------------
1533
1534   `notmuch reply` no longer includes notification that non-leafnode
1535   MIME parts are being suppressed.
1536
1537 Notmuch 0.8 (2011-09-10)
1538 ========================
1539
1540 Improved handling of message/rfc822 parts
1541
1542   Both in the CLI and the emacs interface.  Output of rfc822 parts now
1543   includes the primary headers, as well as the body and all subparts.
1544   Output of the completely raw rfc822-formatted message, including all
1545   headers, is unfortunately not yet supported (but hopefully will be
1546   soon).
1547
1548 Improved Build system portability
1549
1550   Certain parts of the shell script generating notmuch.sym were
1551   specific to the GNU versions of sed and nm. The new version should
1552   be more portable to e.g. OpenBSD.
1553
1554 Documentation update for Ruby bindings
1555
1556   Added documentation, typo fixes, and improved support for rdoc.
1557
1558 Unicode, iterator, PEP8 changes for python bindings
1559
1560   - PEP8 (code formatting) changes for python files.
1561   - Remove `Tags.__len__` ; see 0.6 release notes for motivation.
1562   - Decode headers as UTF8, encode (unicode) database paths as UTF8.
1563
1564 Notmuch 0.7 (2011-08-01)
1565 ========================
1566
1567 Vim interface improvements
1568 --------------------------
1569
1570 Jason Woofenden provided a number of bug fixes for the Vim interface
1571
1572   * fix citation/signature fold lengths
1573   * fix cig/cit parsing within multipart/*
1574   * fix on-screen instructions for show-signature
1575   * fix from list reformatting in search view
1576   * fix space key: now archives (did opposite)
1577
1578 Uwe Kleine-König contributed
1579
1580   * use full path for sendmail/doc fix
1581   * fix compose temp file name
1582
1583 Python Bindings changes
1584 -----------------------
1585
1586 Sebastian Spaeth contributed two changes related to unicode and UTF8:
1587
1588   * message tags are now explicitly unicode
1589   * query string is encoded as a UTF8 byte string
1590
1591 Build-System improvements
1592 -------------------------
1593
1594 Generate notmuch.sym after the relevant object files
1595
1596   This fixes a bug in parallel building. Thanks to Thomas Jost for the
1597   patch.
1598
1599 Notmuch 0.6.1 (2011-07-17)
1600 ==========================
1601
1602 Bug-fix release
1603 ---------------
1604
1605 Re-export Xapian exception typeinfo symbols
1606
1607   It turned out our aggressive symbol hiding caused problems for
1608   people running gcc 4.4.5.
1609
1610 Notmuch 0.6 (2011-07-01)
1611 =======================
1612
1613 New, general features
1614 ---------------------
1615
1616 Folder-based searching
1617
1618   Notmuch queries can now include a search term to match the
1619   directories in which mail files are stored (within the mail
1620   storage). The syntax is as follows:
1621
1622         folder:<path>
1623
1624   For example, one might use things such as:
1625
1626         folder:spam
1627         folder:2011-*
1628         folder:work/todo
1629
1630   to match any path containing a directory "spam", "work/todo", or
1631   containing a directory starting with "2011-", respectively.
1632
1633   This feature is particularly useful for users of delivery-agent
1634   software (such as procmail or maildrop) that is filtering mail and
1635   delivering it to particular folders, or users of systems such as
1636   Gmail that use filesystem directories to indicate message tags.
1637
1638   NOTE: Only messages that are newly indexed with this version of
1639   notmuch will be searchable with folder: terms. In order to enable
1640   this feature for all mail, the entire notmuch index will need to be
1641   rebuilt as follows:
1642
1643         notmuch dump > notmuch.dump
1644         # Backup, then remove notmuch database ($MAIL/.notmuch)
1645         notmuch new
1646         notmuch restore notmuch.dump
1647
1648 Support for PGP/MIME
1649
1650   Both the command-line interface and the emacs-interface have new
1651   support for PGP/MIME, detailed below. Thanks to Daniel Kahn Gillmor
1652   and Jameson Graef Rollins for making this happen.
1653
1654 New, automatic tags: "signed" and "encrypted"
1655
1656   These tags will automatically be applied to messages containing
1657   multipart/signed and multipart/encrypted parts.
1658
1659   NOTE: Only messages that are newly indexed with this version of
1660   notmuch will receive these tags.
1661
1662 New command-line features
1663 -------------------------
1664
1665 Add new "notmuch show --verify" option for signature verification
1666
1667   This option instruct notmuch to verify the signature of
1668   PGP/MIME-signed parts.
1669
1670 Add new "notmuch show --decrypt" and "notmuch reply --decrypt" options
1671
1672   This option instructs notmuch to decrypt PGP/MIME-encrypted parts.
1673   Note that this feature currently requires gpg-agent and a passphrase entry
1674   tool (e.g. pinentry-gtk or pinentry-curses).
1675
1676 Proper nesting of multipart parts in "notmuch show" output
1677
1678   MIME parts are now display with proper nesting to reflect original
1679   MIME hierarchy of a message. This allows clients to correctly
1680   analyze the MIME structure, (such as, for example, determining to
1681   which parts a signature part applies).
1682
1683 Add new "notmuch show --part" option
1684
1685   This is a replacement for the older "notmuch part" command, (which
1686   is now deprecated—it should still work as always, but is no longer
1687   documented). Putting part output under "notmuch show" allows for all
1688   of the "notmuch show" options to be applied when extracting a single
1689   part, (such as --format=json for extracting a message part with JSON
1690   formatting).
1691
1692 Deprecate "notmuch search-tags" (in favor of "notmuch search --output=tags *")
1693
1694   The "notmuch search-tags" sub-command has been redundant since the
1695   addition of the --output=tags option to "notmuch search". We now
1696   make that more clear by deprecating "notmuch search-tags", (dropping
1697   it from the documentation). We do continue to support the old syntax
1698   by translating it internally to the new call.
1699
1700 Performance improvements
1701 ------------------------
1702
1703 Faster searches (by doing fewer searches to construct threads)
1704
1705   Whenever a user asks for search results as threads, notmuch first
1706   performs a search for messages matching the query, then performs
1707   additional searches to find other messages in the resulting threads.
1708
1709   Removing inefficiencies and redundancies in these secondary searches
1710   results in a measured speedups of 1.5x for a typical search.
1711
1712 Faster searches (by doing fewer passes to gather message data)
1713
1714   Optimizing Xapian data access patterns (using a single pass to get
1715   all message-document data rather than a pass for each data type)
1716   results in a measured speedup of 1.7x for a typical search.
1717
1718   The benefits of this optimization combine with the preceding
1719   optimization. With both in place, Austin Clements measured a speedup
1720   of 2.5x for a search of all messages in his inbox (was 4.5s, now
1721   1.8s). Thanks, Austin!
1722
1723 Faster initial indexing
1724
1725   More efficient indexing of new messages results in a measured
1726   speedup of 1.4x for the initial indexing of 3 GB of mail (1h 14m
1727   rather than 1h 46m). Thanks to Austin Clements and Michal Sojka.
1728
1729 Make "notmuch new" faster for unchanged directories
1730
1731   Optimizing to not do any further examinations of sub-directories
1732   when the filesystem indicates that a directory is unchanged from the
1733   last "notmuch new" results in measured speedups of 8.5 for the "No
1734   new mail" case, (was 0.77s, now 0.09s). Thanks to Karel Zak.
1735
1736 New emacs-interface features
1737 ----------------------------
1738
1739 Support for PGP/MIME (GnuPG)
1740
1741   Automatically indicate validity of signatures for multipart/signed
1742   messages.  Automatically display decrypted content for
1743   multipart/encrypted messages.  See the emacs variable
1744   notmuch-crypto-process-mime for more information. Note that this
1745   needs gpg-agent and a pinentry tool just as the command-line tools.
1746   Also note there is no support SMIME yet.
1747
1748 Output of pipe command is now displayed if pipe command fails
1749
1750   This is extremely useful in the common use case of piping a patch to
1751   "git am". If git fails to cleanly merge the patch the error messages
1752   from the failed merge are now clearly displayed to the user, (where
1753   previously they were silently hidden from the user).
1754
1755 User-selectable From address
1756
1757   A user can choose which configured email addresses should be used as
1758   the From address whenever composing a new message. To do so, simply
1759   press C-u before the command which will open a new message. Emacs
1760   will prompt for the from address to use.
1761
1762   The user can customize the "Notmuch Identities" setting in the
1763   notmuch customize group in order to use addresses other than those in
1764   the notmuch configuration file if desired.
1765
1766   The user can also choose to always be prompted for the from address
1767   when composing a new message (without having to use C-u) by setting
1768   the "Notmuch Always Prompt For Sender" option in the notmuch
1769   customize group.
1770
1771 Hiding of repeated subjects in collapsed thread view
1772
1773   In notmuch-show mode, if a collapsed message has the same subject as
1774   its parent, the subject is not shown.
1775
1776 Automatic detection and hiding of original message in top-posted message
1777
1778   When a message contains a line looking something like:
1779
1780         ----- Original Message -----
1781
1782   emacs hides this and all subsequent lines as an "original message",
1783   (allowing the user to click or press enter on the "original message"
1784   button to display it again). This makes the handling of top-posted
1785   citations work much like conventional citations.
1786
1787 New hooks for running code when tags are modified
1788
1789   Some users want to perform additional actions whenever a particular
1790   tag is added/removed from a message. This could be used to, for
1791   example, interface with some external spam-recognition training
1792   tool. To facilitate this, two new hooks are added which can be
1793   modified in the following settings of the notmuch customize group:
1794
1795         Notmuch Before Tag Hook
1796         Notmuch After Tag Hook
1797
1798 New optional support for hiding some multipart/alternative parts
1799
1800   Many emails are sent with redundant content within a
1801   multipart/alternative group (such as a text/plain part as well as a
1802   text/html part). Users can configure the setting:
1803
1804         Notmuch Show All Multipart/Alternative Parts
1805
1806   to "off" in the notmuch customize group to have the interface
1807   automatically hide some part alternatives (such as text/html
1808   parts). This new part hiding is not configured by default yet
1809   because there's not yet a simple way to re-display such a hidden
1810   part if it is not actually redundant with a displayed part.
1811
1812 Better rendering of text/x-vcalendar parts
1813
1814   These parts are now displayed in a format suitable for use with the
1815   emacs diary.
1816
1817 Avoid getting confused by Subject and Author fields with newline characters
1818
1819   Replacing all characters with ASCII code less than 32 with a question mark.
1820
1821 Cleaner display of From line in email messages
1822
1823   Remove double quotes, and drop "name" if it's actually just a repeat of
1824   the email address.
1825
1826 Vim interface improvements
1827 --------------------------
1828
1829 Felipe Contreras provided a number of updates for the vim interface:
1830
1831   * Using sendmail directly rather than mailx,
1832   * Implementing archive in show view
1833   * Add support to mark as read in show and search views
1834   * Add delete commands
1835   * Various cleanups.
1836
1837 Bindings improvements
1838 ---------------------
1839
1840 Ruby bindings are now much more complete
1841
1842   Including `QUERY.sort`, `QUERY.to_s`, `MESSAGE.maildir_flags_to_tags`,
1843   `MESSAGE.tags_to_maildir_flags`, and `MESSAGE.get_filenames`
1844
1845 Python bindings have been updated and extended
1846
1847   (docs online at http://packages.python.org/notmuch/)
1848
1849   New bindings:
1850
1851   - `Message().get_filenames()`, `Message().tags_to_maildir_flags()`,
1852     `Message().maildir_flags_to_tags()`, `list(Threads())` and
1853     `list(Messages)` works now
1854   - `Message().__cmp__()` and `__hash__()`
1855
1856   These allow, for example:
1857
1858         if msg1 == msg2: ...
1859
1860   As well as set arithmetic on `Messages()`:
1861
1862         s1, s2 = set(msgs1), set(msgs2)
1863         s1.union(s2)
1864         s2 -= s1
1865
1866   Removed:
1867
1868   - `len(Messages())` as it exhausted the iterator
1869
1870   Use `len(list(Messages()))` or `Query.count_messages()`
1871   to get the length.
1872
1873 Added initial Go bindings in bindings/go
1874
1875 New build-system features
1876 -------------------------
1877
1878 Added support for building in a directory other than the source directory
1879
1880   This can be used with the widely-supported idiom of simply running
1881   the configure script from some other directory:
1882
1883         mkdir build
1884         cd build
1885         ../configure
1886         make
1887
1888 Fix to save configure options for future, implicit runs of configure
1889
1890   When a user updates the source (such as with "git pull") calling
1891   "make" may cause an automatic re-run of the configure script. When
1892   this happens, the configure script will automatically be called with
1893   the same options the user originally passed in the most-recent
1894   manual invocation of configure.
1895
1896 New test-suite feature
1897 ----------------------
1898
1899 Binary for bash for running test suite now located via PATH
1900
1901   The notmuch test suite requires a fairly recent version of bash (>=
1902   bash 4). As some systems supply an older version of bash at
1903   /bin/bash, the test suite is now updated to search $PATH to locate
1904   the bash binary. This allows users of systems with old /bin/bash to
1905   simply install bash >= 4 somewhere on $PATH before /bin and then use
1906   the test suite.
1907
1908 Support for testing output with a trailing newline
1909
1910   Previously, some tests would fail to notice a difference in the
1911   presence/absence of a trailing newline in a program output, (which
1912   has led to bugs in the past). Now, carefully-written tests (using
1913   `test_expect_equal_file` rather than `test_expect_equal`) will detect
1914   any change in the presence/absence of a trailing newline. Many tests
1915   are updated to take advantage of this.
1916
1917 Avoiding accessing user's $HOME while running test suite
1918
1919   The test suite now carefully creates its own HOME directory. This
1920   allows the test suite to be run with no existing HOME directory, (as
1921   some build systems apparently do), and avoids test-suite differences
1922   due to configuration files in the users HOME directory.
1923
1924
1925 General bug fixes
1926 -----------------
1927
1928 Output *all* files for "notmuch search --output=files"
1929
1930   For the cases where multiple files have the same Message ID,
1931   previous versions of notmuch would output only one such file. This
1932   command is now fixed to correctly output all files.
1933
1934 Fixed spurious search results from "overlapped" indexing of addresses
1935
1936   This fixed a bug where a search for:
1937
1938         to:user@elsewhere.com
1939
1940   would incorrectly match a message sent:
1941
1942         To: user@example,com, someone@elsewhere.com
1943
1944 Fix --output=json when search has no results
1945
1946   A bug present since notmuch 0.4 had caused searches with no results
1947   to produce an invalid json object. This is now fixed to cleanly
1948   return a valid json object representing an empty array "[]" as
1949   expected.
1950
1951 Fix the automatic detection of the From address for "notmuch reply"
1952 from the Received headers in some cases
1953
1954 Fix core dump on DragonFlyBSD due to -1 return value from
1955 `sysconf(_SC_GETPW_R_SIZE_MAX)`
1956
1957 Cleaned up several memory leaks
1958
1959 Eliminated a few, rare segmentation faults and a double-free
1960
1961 Fix libnotmuch library to only export notmuch API functions
1962
1963   Previous release of the notmuch library also exported some Xapian
1964   C++ exception type symbols. These were never part of the library
1965   interface and were never intended to be exported.
1966
1967 Emacs-interface bug fixes
1968 -------------------------
1969
1970 Display any unexpected output or errors from "notmuch search" invocations
1971
1972   Previously any misformatted output or trailing error messages were
1973   silently ignored. This output is now clearly displayed. This fix was
1974   very helpful in identifying and fixing the bug described below.
1975
1976 Fix bug where some threads would be missing from large search results
1977
1978   When a search returned a "large" number of results, the emacs
1979   interface was incorrectly dropping one thread every time the output
1980   of the "notmuch search" process spanned the emacs read-buffer. This
1981   is now fixed.
1982
1983 Avoid re-compression of .gz files (and similar) when saving attachment
1984
1985   Emacs was being too clever for its own good and trying to
1986   re-compress pre-compressed .gz files when saving such attachments
1987   (potentially corrupting the attachment). The emacs interface is
1988   fixed to avoid this bug.
1989
1990 Fix hiding of a message when a previously-hidden citation is visible
1991
1992   Previously the citation would remain visible in this case. This is
1993   fixed so that hiding a message hides all parts.
1994
1995 Notmuch 0.5 (2010-11-11)
1996 ========================
1997
1998 New, general features
1999 ---------------------
2000
2001 Maildir-flag synchronization
2002
2003   Notmuch now knows how to synchronize flags in maildir filenames with
2004   tags in the notmuch database. The following flag/tag mappings are
2005   supported:
2006
2007         Flag <-> Tag
2008         ----     -----
2009         'D'      draft
2010         'F'      flagged
2011         'P'      passed
2012         'R'      replied
2013         'S'      unread (added when 'S' flag is not present)
2014
2015   The synchronization occurs in both directions, (for example, adding
2016   the 'S' flag to a file will cause the "unread" tag to be added, and
2017   adding the "replied" tag to a message will cause the file to be
2018   renamed with an 'R' flag).
2019
2020   This synchronization is enabled by default for users of the
2021   command-line interface, (though only files in directories named
2022   "cur" or "new" will be renamed). It can be disabled by setting the
2023   new `maildir.synchronize_flags` option in the configuration file. For
2024   example:
2025
2026         notmuch config set maildir.synchronize_flags false
2027
2028   Users upgrading may also want to run "notmuch setup" once (just
2029   accept the existing configuration) to get a new, nicely-commented
2030   [maildir] section added to the configuration file.
2031
2032   For users of the notmuch library, the new synchronization
2033   functionality is available with the following two new functions:
2034
2035         notmuch_message_maildir_flags_to_tags
2036         notmuch_message_tags_to_maildir_flags
2037
2038   It is anticipated that future improvements to this support will
2039   allow for safe synchronization of the 'T' flag with the "deleted"
2040   tag, as well as support for custom flag/tag mappings.
2041
2042 New library features
2043 --------------------
2044
2045 Support for querying multiple filenames for a single message
2046
2047   It is common for the mailstore to contain multiple files with the
2048   same message ID. Previously, notmuch would always hide these
2049   duplicate files, (returning a single, arbitrary filename with
2050   `notmuch_message_get_filename`).
2051
2052   With this release, library users can access all filenames for a
2053   message with the new function:
2054
2055         notmuch_message_get_filenames
2056
2057   Together with `notmuch_filenames_valid`, `notmuch_filenames_get`,
2058   and `notmuch_filenames_move_to_next` it is now possible to iterate
2059   over all available filenames for a given message.
2060
2061 New command-line features
2062 -------------------------
2063
2064 New "notmuch show --format=raw" for getting at original email contents
2065
2066   This new feature allows for a fully-functional email client to be
2067   built on top of the notmuch command-line without needing any direct
2068   access to the mail store itself.
2069
2070   For example, it's now possible to run "emacs -f notmuch" on a local
2071   machine with only ssh access to the mail store/notmuch database. To
2072   do this, simply set the notmuch-command variable in emacs to the
2073   name of a script containing:
2074
2075         ssh user@host notmuch "$@"
2076
2077   If the ssh client has enabled connection sharing (ControlMaster
2078   option in OpenSSH), the emacs interface can be quite responsive this
2079   way.
2080
2081 General bug fixes
2082 -----------------
2083
2084 Fix "notmuch search" to print nothing when nothing matches
2085
2086   The 0.4 release had a bug in which:
2087
2088         notmuch search <expression-with-no-matches>
2089
2090   would produce a single blank line of output, (where previous
2091   versions would produce no output. This fix also causes a change in
2092   the --format=json output, (which would previously produce "[]" and
2093   now produces nothing).
2094
2095 Emacs interface improvements
2096 ----------------------------
2097
2098 Fix to allow pipe ('|') command to work when using notmuch over ssh
2099
2100 Fix count of lines in hidden signatures
2101
2102 Omit repeated subject lines in (collapsed) thread display
2103
2104 Display current thread subject in a header line
2105
2106 Provide a "c i" binding to copy a thread ID from the search view
2107
2108 Allow for notmuch-fcc-dirs to have a value of nil
2109
2110   Also, the more complex form of notmuch-fcc-dirs now has a slightly
2111   different format. It no longer has a special first-element, fallback
2112   string. Instead it's now a list of cons cells where the car of each
2113   cell is a regular expression to be matched against the sender
2114   address, and the cdr is the name of a folder to use for an FCC. So
2115   the old fallback behavior can be achieved by including a final cell
2116   of (".*" . "default-fcc-folder").
2117
2118 Vim interface improvements
2119 --------------------------
2120
2121 Felipe Contreras provided a number of updates for the vim interface
2122
2123   These include optimizations, support for newer versions of vim, fixed
2124   support for sending mail on modern systems, new commands, and
2125   various cleanups.
2126
2127 New bindings
2128 ------------
2129
2130 Added initial ruby bindings in bindings/ruby
2131
2132 Notmuch 0.4 (2010-11-01)
2133 ========================
2134
2135 New command-line features
2136 -------------------------
2137
2138 `notmuch search --output=(summary|threads|messages|tags|files)`
2139
2140   This new option allows for particular items to be returned from
2141   notmuch searches. The "summary" option is the default and behaves
2142   just as "notmuch search" has historically behaved.
2143
2144   The new option values allow for thread IDs, message IDs, lists of
2145   tags, and lists of filenames to be returned from searches. It is
2146   expected that this new option will be very useful in shell
2147   scripts. For example:
2148
2149         for file in $(notmuch search --output=files <search-terms>); do
2150                 <operations-on> "$file"
2151         done
2152
2153 `notmuch show --format=mbox <search-specification>`
2154
2155   This new option allows for the messages matching a search
2156   specification to be presented as an mbox. Specifically the "mboxrd"
2157   format is used which allows for reversible quoting of lines
2158   beginning with "From ". A reader should remove a single '>' from the
2159   beginning of all lines beginning with one or more '>' characters
2160   followed by the 5 characters "From ".
2161
2162 `notmuch config [get|set] <section>.<item> [value ...]`
2163
2164   The new top-level "config" command allows for any value in the
2165   notmuch configuration file to be queried or set to a new value. Both
2166   single-valued and multi-valued items are supported, as our any
2167   custom items stored in the configuration file.
2168
2169 Avoid setting Bcc header in "notmuch reply"
2170
2171   We decided that this was a bit heavy-handed as the actual mail
2172   user-agent should be responsible for setting any Bcc option. Also,
2173   see below for the notmuch/emacs user-agent now setting an Fcc by
2174   default rather than Bcc.
2175
2176 New library features
2177 --------------------
2178
2179 Add `notmuch_query_get_query_string` and `notmuch_query_get_sort`
2180
2181   These are simply functions for querying properties of a
2182   `notmuch_query_t` object.
2183
2184 New emacs features
2185 ------------------
2186
2187 Enable Fcc of all sent messages by default (to "sent" directory)
2188
2189   All messages sent from the emacs interface will now be saved to the
2190   notmuch mail store where they will be incorporated to the database
2191   by the next "notmuch new". By default, messages are saved to the
2192   "sent" directory at the top-level of the mail store. This directory
2193   can be customized by means of the "Notmuch Fcc Dirs" option in the
2194   notmuch customize interface.
2195
2196 Ability to all open messages in a thread to a pipe
2197
2198   Historically, the '|' keybinding allows for piping a single message
2199   to an external command. Now, by prefixing this key with a prefix
2200   argument, (for example, by pressing "Control-U |"), all open
2201   messages in the current thread will be sent to the external command.
2202
2203 Optional support for detecting inline patches
2204
2205   This hook is disabled by default but can be enabled with a checkbox
2206   under "Notmuch Show Insert Text/Plain Hook" in the notmuch customize
2207   interface. It allows for inline patches to be detected and treated
2208   as if they were attachments, (with context-sensitive highlighting).
2209
2210 Automatically tag messages as "replied" when sending a reply
2211
2212   Messages replied to within the emacs interface will now be tagged as
2213   "replied". This feature can easily be customized to add or remove
2214   other tags as well. For example, a user might use a tag of
2215   "needs-reply" and can configure this feature to automatically remove
2216   that tag when replying. See "Notmuch Message Mark Replied" in the
2217   notmuch customize interface.
2218
2219 Allow search-result color specifications to overlay each other
2220
2221   For example, one tag can specify the background color of matching
2222   lines, while another can specify the foreground. With this change,
2223   both settings will now be visible simultaneously, (which was not the
2224   case in previous releases). See "Notmuch Search Line Faces" in the
2225   notmuch customize interface.
2226
2227 Make hidden author names still available for incremental search
2228
2229   When there is insufficient space to display all authors of a thread
2230   in search results, the names of hidden authors are now still made
2231   available to emacs' incremental search commands. As the user
2232   searches, matching lines will temporarily expand to show the hidden
2233   names.
2234
2235 New binding of Control-TAB (works like TAB in reverse)
2236
2237   Many notmuch nodes already use TAB to navigate forward through
2238   various items allowing actions, (message headers, email attachments,
2239   etc.). The new Control-TAB binding operates similarly but in the
2240   opposite direction.
2241
2242 New build-system features
2243 -------------------------
2244
2245 Various portability fixes have been applied
2246
2247   These include fixes for build failures on at least Solaris, FreeBSD,
2248   and Fedora systems. We're hopeful that the notmuch code base is now
2249   more portable than ever before.
2250
2251 Arrange for libnotmuch to be found automatically after make install
2252
2253   The notmuch build system is now careful to help the user avoid
2254   errors of the form "libnotmuch.so could not be found" immediately
2255   after installing. This support takes two forms:
2256
2257   1. If the library is installed to a system directory,
2258      (configured in /etc/ld.so.conf), then "make install" will
2259      automatically run ldconfig.
2260
2261   2. If the library is installed to a non-system directory, the
2262      build system adds a `DR_RUNPATH` entry to the final binary
2263      pointing to the directory to which the library is installed.
2264
2265   When this support works, the user should be able to run notmuch
2266   immediately after "make install", without any errors trying to find
2267   the notmuch library, and without having to manually set environment
2268   variables such as `LD_LIBRARY_PATH`.
2269
2270 Check compiler/linker options before using them
2271
2272   The configure script now carefully checks that any desired
2273   compilation options, (whether for enabling compiler warnings, or for
2274   embedding rpath, etc.), are supported. Only supported options are
2275   used in the resulting Makefile.
2276
2277 New test-suite features
2278 -----------------------
2279
2280 New modularization of test suite
2281
2282   Thanks to a gracious relicensing of the test-suite infrastructure
2283   from the git project, notmuch now has a modular test suite. This
2284   provides the ability to run individual sections of the test suite
2285   rather than the whole things. It also provides better summary of
2286   test results, with support for tests that are expected to fail
2287   (BROKEN and FIXED) in addition to PASS and FAIL. Finally, it makes
2288   it easy to run the test suite within valgrind (pass --valgrind to
2289   notmuch-test or to any sub-script) which has been very useful.
2290
2291 New testing of emacs interface
2292
2293   The test suite has been augmented to allow automated testing of the
2294   emacs interfaces. So far, this includes basic searches, display of
2295   threads, and tag manipulation. This also includes a test that a new
2296   message can successfully be sent out through a (dummy) SMTP server
2297   and that said message is successfully integrated into the notmuch
2298   database via the FCC setting.
2299
2300 General bug fixes
2301 -----------------
2302
2303 Fix potential corruption of database when "notmuch new" is interrupted
2304
2305   Previously, an interruption of "notmuch new" would (rarely) result
2306   in a corrupt database. The corruption would manifest itself by a
2307   persistent error of the form:
2308
2309         document ID of 1234 has no thread ID
2310
2311   The message-adding code has been carefully audited and reworked to
2312   avoid this sort of corruption regardless of when it is interrupted.
2313
2314 Fix failure with extremely long message ID headers
2315
2316   Previously, a message with an extremely long message ID, (say, more
2317   than 300 characters), would fail to be added to notmuch, (triggering
2318   Xapian exceptions). This has now been fixed.
2319
2320 Fix for messages with "charset=unknown-8bit"
2321
2322   Previously, messages with this charset would cause notmuch to emit a
2323   GMime warning, (which would then trip up emacs or other interfaces
2324   parsing the notmuch results).
2325
2326 Fix `notmuch_query_search_threads` function to return NULL on any exception
2327
2328 Fix "notmuch search" to return non-zero if `notmuch_query_search_threads`
2329 fails
2330
2331   Previously, this command could confusingly report a Xapian
2332   exception, yet still return an error code of 0. It now correctly
2333   returns a failing error code of 1 in this case.
2334
2335 Emacs bug fixes
2336 ---------------
2337
2338 Fix to handle a message with a subject containing, for example "[1234]"
2339
2340   Previously, a message subject containing a sequence of digits within
2341   square brackets would cause the emacs interface to mis-parse the
2342   output of "notmuch search". This would result in the message being
2343   mis-displayed and prevent the user from manipulating the message in
2344   the emacs interface.
2345
2346 Fix to correctly handle message IDs containing ".."
2347
2348   The emacs interface now properly quotes message IDs to avoid a
2349   Xapian bug in which the ".." within a message ID would be
2350   misinterpreted as a numeric range specification.
2351
2352 Python-binding fixes
2353 --------------------
2354
2355 The python bindings for notmuch have been updated to work with python3.
2356
2357 Debian-specific fixes
2358 ---------------------
2359
2360 Fix emacs initialization so "M-x notmuch" works for users by default
2361
2362   Now, a new Debian user can immediately run "emacs -f notmuch" after
2363   "apt-get install notmuch". Previously, the user would have had to
2364   edit the ~/.emacs file to add "(require 'notmuch)" before this would
2365   work.
2366
2367 Notmuch 0.3.1 (2010-04-27)
2368 ==========================
2369
2370 General bug fixes
2371 -----------------
2372
2373 Fix an infinite loop in "notmuch reply"
2374
2375   This bug could be triggered by replying to a message where the
2376   user's primary email address did not appear in the To: header and
2377   the user had not configured any secondary email addresses. The bug
2378   was a simple re-use of the same iterator variable in nested loops.
2379
2380 Fix a potential SEGV in "notmuch search"
2381
2382   This bug could be triggered by an author name ending in a ','.
2383   Admittedly - that's almost certainly a spam email, but we never
2384   want notmuch to crash.
2385
2386 Emacs bug fixes
2387 ---------------
2388
2389 Fix calculations for line wrapping in the primary "notmuch" view
2390
2391 Fix Fcc support to prompt to create a directory if the specified Fcc
2392 directory does not exist
2393
2394 Build fix
2395 ---------
2396
2397 Fix build on OpenSolaris (at least) due to missing 'extern "C"' block
2398
2399   Without this, the C++ sources could not find strcasestr and the
2400   final linking of notmuch would fail.
2401
2402 Notmuch 0.3 (2010-04-27)
2403 ========================
2404
2405 New command-line features
2406 -------------------------
2407
2408 User-configurable tags for new messages
2409
2410   A new "new.tags" option is available in the configuration file to
2411   determine which tags are applied to new messages. Run "notmuch
2412   setup" to generate new documentation within ~/.notmuch-config on how
2413   to specify this value.
2414
2415 Threads search results named based on subjects that match search
2416
2417   This means that when new mails arrived to a thread you've previously
2418   read, and the new mails have a new subject, you will see that
2419   subject in the search results rather than the old subject.
2420
2421 Faster operation of "notmuch tag" (avoid unneeded sorting)
2422
2423   Since the user just wants to tag all matching messages, we can make
2424   things perform a bit faster by avoiding the sort.
2425
2426 Even Better guessing of From: header for "notmuch reply"
2427
2428   Notmuch now looks at a number of headers when trying to figure out
2429   the best From: header to use in a reply. This is helpful if you have
2430   several configured email addresses, and you also subscribe to various
2431   mailing lists with different addresses, (so that mails you are
2432   replying to won't always include your subscribed address in the To:
2433   header).
2434
2435 Indication of author names that match a search
2436
2437   When notmuch displays threads as the result of a search, it now
2438   lists the authors that match the search before listing the other
2439   authors in the thread. It inserts a pipe '|' symbol between the last
2440   matching and first non-matching author. This is especially useful in
2441   a search that includes tag:unread. Now the authors of the unread
2442   messages in the thread are listed first.
2443
2444 New: Python bindings
2445 --------------------
2446
2447 Sebastian Spaeth has contributed his python bindings for the notmuch
2448 library to the central repository. These bindings were previously
2449 known as "cnotmuch" within python but have now been renamed to be
2450 accessible with a simple, and more official-looking "import notmuch".
2451
2452 The bindings have already proven very useful as people proficient in
2453 python have been able to easily develop programs to do notmuch-based
2454 searches for email-address completion, maildir-flag synchronization,
2455 and other tasks.
2456
2457 These bindings are available within the bindings/python directory, but
2458 are not yet integrated into the top-level Makefiles, nor the top-level
2459 package-building scripts. Improvements are welcome.
2460
2461 Emacs interface improvements
2462 ----------------------------
2463
2464 An entirely new initial view for notmuch, (friendly yet powerful)
2465
2466   Some of us call the new view "notmuch hello" but you can get at it
2467   by simply calling "emacs -f notmuch". The new view provides a search
2468   bar where new searches can be performed. It also displays a list of
2469   recent searches, along with a button to save any of these, giving it
2470   a new name as a "saved search". Many people find these "saved
2471   searches" one of the most convenient ways of organizing their mail,
2472   (providing all of the features of "folders" in other mail clients,
2473   but without any of the disadvantages).
2474
2475   Finally, this view can also optionally display all of the tags that
2476   exist in the database, along with a count for each tag, and a custom
2477   search of messages with that tag that's simply a click (or keypress)
2478   away.
2479
2480   NOTE: For users that liked the original mode of "emacs -f notmuch"
2481   immediately displaying a particular search result, we recommend
2482   instead running something like:
2483
2484         emacs --eval '(notmuch search "tag:inbox" t)'
2485
2486   The "t" means to sort the messages in an "oldest first" order,
2487   (as notmuch would do previously by default). You can also
2488   leave that off to have your search results in "newest first"
2489   order.
2490
2491 Full-featured "customize" support for configuring notmuch
2492
2493   Notmuch now plugs in well to the emacs "customize" mode to make it
2494   much simpler to find things about the notmuch interface that can be
2495   tweaked by the user.
2496
2497   You can get to this mode by starting at the main "Customize" menu in
2498   emacs, then browsing through "Applications", "Mail", and
2499   "Notmuch". Or you can go straight to "M-x customize-group"
2500   "notmuch".
2501
2502   Once you're at the customize screen, you'll see a list of documented
2503   options that can be manipulated along with checkboxes, drop-down
2504   selectors, and text-entry boxes for configuring the various
2505   settings.
2506
2507 Support for doing tab-completion of email addresses
2508
2509   This support currently relies on an external program,
2510   (notmuch-addresses), that is not yet shipped with notmuch
2511   itself. But multiple, suitable implementations of this program have
2512   already been written that generate address completions by doing
2513   notmuch searches of your email collection. For example, providing
2514   first those addresses that you have composed messages to in the
2515   past, etc.
2516
2517   One such program (implemented in python with the python bindings to
2518   notmuch) is available via:
2519
2520         git clone  http://jkr.acm.jhu.edu/git/notmuch_addresses.git
2521
2522   Install that program as notmuch-addresses on your PATH, and then
2523   hitting TAB on a partial email address or name within the To: or Cc:
2524   line of an email message will provide matching completions.
2525
2526 Support for file-based (Fcc) delivery of sent messages to mail store
2527
2528   This isn't yet enabled by default. To enable this, one will have to
2529   set the "Notmuch Fcc Dirs" setting within the notmuch customize
2530   screen, (see its documentation there for details). We anticipate
2531   making this automatic in a future release.
2532
2533 New 'G' key binding to trigger mail refresh (G == "Get new mail")
2534
2535   The 'G' key works wherever '=' works. Before refreshing the screen
2536   it calls an external program that can be used to poll email servers,
2537   run notmuch new and setup specific tags for the new emails. The
2538   script to be called should be configured with the "Notmuch Poll
2539   Script" setting in the customize interface. This script will
2540   typically invoke "notmuch new" and then perhaps several "notmuch
2541   tag" commands.
2542
2543 Implement emacs message display with the JSON output from notmuch
2544
2545   This is much more robust than the previous implementation, (where
2546   some HTML mails and mail quoting the notmuch code with the delimiter
2547   characters in it would cause the parser to fall over).
2548
2549 Better handling of HTML messages and MIME attachments (inline images!)
2550
2551   Allow for any MIME parts that emacs can display to be displayed
2552   inline. This includes inline viewing of image attachments, (provided
2553   the window is large enough to fit the image at its natural size).
2554
2555   Much more robust handling of HTML messages. Currently both text/plain
2556   and text/html alternates will be rendered next to each other. In a
2557   future release, users will be able to decide to see only one or the
2558   other representation.
2559
2560   Each attachment now has its own button so that attachments can be
2561   saved individually (the 'w' key is still available to save all
2562   attachments).
2563
2564 Customizable support for tidying of text/plain message content
2565
2566   Many new functions are available for tidying up message
2567   content. These include options such as wrapping long lines,
2568   compressing duplicate blank lines, etc.
2569
2570   Most of these are disabled by default, but can easily be enabled by
2571   clicking the available check boxes under the "Notmuch Show Insert
2572   Text/Plain Hook" within the notmuch customize screen.
2573
2574 New support for searchable citations (even when hidden)
2575
2576   When portions of overly-long citations are hidden, the contents of
2577   these citations will still be available for emacs' standard
2578   "incremental search" functions. When the search matches any portion
2579   of a hidden citation, the citation will become visible temporarily
2580   to display the search result.
2581
2582 More flexible handling of header visibility
2583
2584   As an answer to complaints from many users, the To, Cc, and Date
2585   headers of messages are no longer hidden by default. For those users
2586   that liked that these were hidden, a new "Notmuch Messages Headers
2587   Visible" option in the customize interface can be set to nil. The
2588   visibility of headers can still be toggled on a per-message basis
2589   with the 'h' keybinding.
2590
2591   For users that don't want to see some subset of those headers, the
2592   new "Notmuch Message Headers" variable can be customized to list
2593   only those headers that should be present in the display of a message.
2594
2595 The Return key now toggles message visibility anywhere
2596
2597   Previously this worked only on the first summary-line of a message.
2598
2599 Customizable formatting of search results
2600
2601   The user can easily customize the order, width, and formatting of
2602   the various fields in a "notmuch search" buffer. See the "Notmuch
2603   Search Result Format" section of the customize interface.
2604
2605 Generate nicer names for search buffers when using a saved search
2606
2607 Add a notmuch User-Agent header when sending mail from notmuch/emacs
2608
2609 New keybinding (M-Ret) to open all collapsed messages in a thread
2610
2611 New library feature
2612 -------------------
2613
2614 Provide a new `NOTMUCH_SORT_UNSORTED` value for queries
2615
2616   This can be somewhat faster when sorting simply isn't desired. For
2617   example when collecting a set of messages that will all be
2618   manipulated identically, (adding a tag, removing a tag, deleting the
2619   messages), then there's no advantage to sorting the messages by
2620   date.
2621
2622 Build fixes
2623 -----------
2624
2625 Fix to compile against GMime 2.6
2626
2627   Previously notmuch insisted on being able to find GMime 2.4, (even
2628   though GMime 2.6 would have worked all along).
2629
2630 Fix configure script to accept (and ignore) various standard options
2631
2632   For example, those that the Gentoo build scripts expect configure to
2633   accept are now all accepted.
2634
2635 Test suite
2636 ----------
2637
2638 A large number of new tests for the many new features
2639
2640 Better display of output from failed tests
2641
2642   Now shows failures with diff rather than forcing the user to gaze at
2643   complete actual and expected output looking for deviation.
2644
2645 Notmuch 0.2 (2010-04-16)
2646 ========================
2647
2648 This is the second release of the notmuch mail system, with actual
2649 detailed release notes this time!
2650
2651 This release consists of a number of minor new features that make
2652 notmuch more pleasant to use, and a few fairly major bug fixes.
2653
2654 We didn't quite hit our release target of "about a week" from the 0.1
2655 release, (0.2 is happening 11 days after 0.1), but we hope to do
2656 better for next week. Look forward to some major features coming to
2657 notmuch in subsequent releases.
2658
2659 -Carl
2660
2661 General features
2662 ----------------
2663
2664 Better guessing of From: header
2665
2666   Notmuch now tries harder to guess which configured address should be
2667   used as the From: line in a "notmuch reply". It will examine the
2668   Received: headers if it fails to find any configured address in To:
2669   or Cc:. This allows it to often choose the correct address even when
2670   replying to a message sent to a mailing list, and not directly to a
2671   configured address.
2672
2673 Make "notmuch count" with no arguments count all messages
2674
2675   Previously, it was hard to construct a search term that was
2676   guaranteed to match all messages.
2677
2678 Provide a new special-case search term of "*" to match all messages
2679
2680   This can be used in any command accepting a search term, such as
2681   "notmuch search '*'". Note that you'll want to take care that the
2682   shell doesn't expand * against the current files. And note that the
2683   support for "*" is a special case. It's only meaningful as a single
2684   search term and loses its special meaning when combined with any
2685   other search terms.
2686
2687 Automatically detect thread connections even when a parent message is
2688 missing
2689
2690   Previously, if two or more message were received with a common
2691   parent, but that parent was not received, then these messages would
2692   not be recognized as belonging to the same thread. This is now fixed
2693   so that such messages are properly connected in a thread.
2694
2695 General bug fixes
2696 -----------------
2697
2698 Fix potential data loss in "notmuch new" with SIGINT
2699
2700   One code path in "notmuch new" was not properly handling
2701   SIGINT. Previously, this could lead to messages being removed from
2702   the database (and their tags being lost) if the user pressed
2703   Control-C while "notmuch new" was working.
2704
2705 Fix segfault when a message includes a MIME part that is empty
2706
2707 Fix handling of non-ASCII characters with --format=json
2708
2709   Previously, characters outside the range of 7-bit ASCII were
2710   silently dropped from the JSON output. This led to corrupted display
2711   of utf-8 content in the upcoming notmuch web-based frontends.
2712
2713 Fix headers to be properly decoded in "notmuch reply"
2714
2715   Previously, the user might see:
2716
2717         Subject: Re: =?iso-8859-2?q?Rozlu=E8ka?=
2718
2719   rather than:
2720
2721         Subject: Re: Rozlučka
2722
2723   The former text is properly encoded to be RFC-compliant SMTP, will
2724   be sent correctly, and will be properly decoded by the
2725   recipient. But the user trying to edit the reply would likely be
2726   unable to read or edit that field in its encoded form.
2727
2728 Emacs client features
2729 ---------------------
2730
2731 Show the last few lines of citations as well as the first few lines
2732
2733   It's often the case that the last sentence of a citation is what is
2734   being replied to directly, so the last few lines are often much more
2735   important. The number of lines shown at the beginning and end of any
2736   citation can be configured, (notmuch-show-citation-lines-prefix and
2737   notmuch-show-citation-lines-suffix).
2738
2739 The '+' and '-' commands in the search view can now add and remove
2740 tags by region
2741
2742   Selective bulk tagging is now possible by selecting a region of
2743   threads and then using either the '+' or '-' keybindings. Bulk
2744   tagging is still available for all threads matching the current
2745   search with the '*' binding.
2746
2747 More meaningful buffer names for thread-view buffers
2748
2749   Notmuch now uses the Subject of the thread as the buffer
2750   name. Previously it was using the thread ID, which is a meaningless
2751   number to the user.
2752
2753 Provide for customized colors of threads in search view based on tags
2754
2755   See the documentation of notmuch-search-line-faces, (or us "M-x
2756   customize" and browse to the "notmuch" group within "Applications"
2757   and "Mail"), for details on how to configure this colorization.
2758
2759 Build-system features
2760 ---------------------
2761
2762 Add support to properly build libnotmuch on Darwin systems (OS X)
2763
2764 Add support to configure for many standard options
2765
2766   We include actual support for:
2767
2768         --includedir --mandir --sysconfdir
2769
2770   And accept and silently ignore several more:
2771
2772         --build --infodir --libexecdir --localstatedir
2773         --disable-maintainer-mode --disable-dependency-tracking
2774
2775 Install emacs client in "make install" rather than requiring a
2776 separate "make install-emacs"
2777
2778 Automatically compute versions numbers between releases
2779
2780   This support uses the git-describe notation, so a version such as
2781   0.1-144-g43cbbfc indicates a version that is 144 commits since the
2782   0.1 release and is available as git commit "43cbbfc".
2783
2784 Add a new "make test" target to run the test suite and actually
2785 verify its results
2786
2787 Notmuch 0.1 (2010-04-05)
2788 ========================
2789
2790 This is the first release of the notmuch mail system.
2791
2792 It includes the libnotmuch library, the notmuch command-line
2793 interface, and an emacs-based interface to notmuch.
2794
2795 Note: Notmuch will work best with Xapian 1.0.18 (or later) or Xapian
2796 1.1.4 (or later). Previous versions of Xapian (whether 1.0 or 1.1) had
2797 a performance bug that made notmuch very slow when modifying
2798 tags. This would cause distracting pauses when reading mail while
2799 notmuch would wait for Xapian when removing the "inbox" and "unread"
2800 tags from messages in a thread.
2801
2802
2803 <!--
2804  Local variables:
2805  mode: text
2806  tab-width: 8
2807  indent-tabs-mode: nil
2808  End:
2809  vi: sw=8 ts=8 et
2810 -->