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