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