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