git.notmuchmail.org Git - notmuch/blob - NEWS

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