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