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