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