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