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