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