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