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