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