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