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