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