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