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