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