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