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