Merge branch '0.3.x' immediately after the 0.3.1 release
[notmuch] / NEWS
1 New emacs features
2 ------------------
3 Add a new, optional hook for detecting inline patches
4
5   This hook is disabled by default but can be enabled with a checkbox
6   under ""Notmuch Show Insert Text/Plain Hook" in the notmuch
7   customize interface. It allows for inline patches to be detected and
8   treated as if they were attachments, (with context-sensitive
9   highlighting).
10
11 Automatically tag messages as "replied" when sending a reply
12
13   This feature adds a "replied" tag by default, but can easily be
14   customized to add or remove other tags as well. For example, a user
15   might use a tag of "needs-reply" and can configure this feature to
16   automatically remove that tag when replying. See "Notmuch Message
17   Mark Replied" in the notmuch customize interface.
18
19 Notmuch 0.3.1 (2010-04-27)
20 ==========================
21 General bug fixes
22 -----------------
23 Fix an infinite loop in "notmuch reply"
24
25   This bug could be triggered by replying to a message where the
26   user's primary email address did not appear in the To: header and
27   the user had not configured any secondary email addresses. The bug
28   was a simple re-use of the same iterator variable in nested loops.
29
30 Fix a potential SEGV in "notmuch search"
31
32   This bug could be triggered by an author name ending in a ','.
33   Admittedly - that's almost certainly a spam email, but we never
34   want notmuch to crash.
35
36 Emacs bug fixes
37 ---------------
38 Fix calculations for line wrapping in the primary "notmuch" view.
39
40 Fix Fcc support to prompt to create a directory if the specified Fcc
41 directory does not exist.
42
43 Build fix
44 ---------
45 Fix build on OpenSolaris (at least) due to missing 'extern "C"' block.
46
47   Without this, the C++ sources could not find strcasestr and the
48   final linking of notmuch would fail.
49
50 Notmuch 0.3 (2010-04-27)
51 ========================
52 New command-line features
53 -------------------------
54 User-configurable tags for new messages
55
56   A new "new.tags" option is available in the configuration file to
57   determine which tags are applied to new messages. Run "notmuch
58   setup" to generate new documentation within ~/.notmuch-config on how
59   to specify this value.
60
61 Threads search results named based on subjects that match search
62
63   This means that when new mails arrived to a thread you've previously
64   read, and the new mails have a new subject, you will see that
65   subject in the search results rather than the old subject.
66
67 Faster operation of "notmuch tag" (avoid unneeded sorting)
68
69   Since the user just wants to tag all matching messages, we can make
70   things perform a bit faster by avoiding the sort.
71
72 Even Better guessing of From: header for "notmuch reply"
73
74   Notmuch now looks at a number of headers when trying to figure out
75   the best From: header to use in a reply. This is helpful if you have
76   several configured email addresses, and you also subscribe to various
77   mailing lists with different addresses, (so that mails you are
78   replying to won't always include your subscribed address in the To:
79   header).
80
81 Indication of author names that match a search
82
83   When notmuch displays threads as the result of a search, it now
84   lists the authors that match the search before listing the other
85   authors in the thread. It inserts a pipe '|' symbol between the last
86   matching and first non-matching author. This is especially useful in
87   a search that includes tag:unread. Now the authors of the unread
88   messages in the thread are listed first.
89
90 New: Python bindings
91 --------------------
92 Sebastian Spaeth has contributed his python bindings for the notmuch
93 library to the central repository. These bindings were previously
94 known as "cnotmuch" within python but have now been renamed to be
95 accessible with a simple, and more official-looking "import notmuch".
96
97 The bindings have already proven very useful as people proficient in
98 python have been able to easily develop programs to do notmuch-based
99 searches for email-address completion, maildir-flag synchronization,
100 and other tasks.
101
102 These bindings are available within the bindings/python directory, but
103 are not yet integrated into the top-level Makefiles, nor the top-level
104 package-building scripts. Improvements are welcome.
105
106 Emacs interface improvements
107 ----------------------------
108 An entirely new initial view for notmuch, (friendly yet powerful)
109
110   Some of us call the new view "notmuch hello" but you can get at it
111   by simply calling "emacs -f notmuch". The new view provides a search
112   bar where new searches can be performed. It also displays a list of
113   recent searches, along with a button to save any of these, giving it
114   a new name as a "saved search". Many people find these "saved
115   searches" one of the most convenient ways of organizing their mail,
116   (providing all of the features of "folders" in other mail clients,
117   but without any of the disadvantages).
118
119   Finally, this view can also optionally display all of the tags that
120   exist in the database, along with a count for each tag, and a custom
121   search of messages with that tag that's simply a click (or keypress)
122   away.
123
124   Note: For users that liked the original mode of "emacs -f notmuch"
125         immediately displaying a particular search result, we
126         recommend instead running something like:
127
128                 emacs --eval '(notmuch search "tag:inbox" t)'
129
130         The "t" means to sort the messages in an "oldest first" order,
131         (as notmuch would do previously by default). You can also
132         leave that off to have your search results in "newest first"
133         order.
134
135 Full-featured "customize" support for configuring notmuch
136
137   Notmuch now plugs in well to the emacs "customize" mode to make it
138   much simpler to find things about the notmuch interface that can be
139   tweaked by the user.
140
141   You can get to this mode by starting at the main "Customize" menu in
142   emacs, then browsing through "Applications", "Mail", and
143   "Notmuch". Or you can go straight to "M-x customize-group"
144   "notmuch".
145
146   Once you're at the customize screen, you'll see a list of documented
147   options that can be manipulated along with checkboxes, drop-down
148   selectors, and text-entry boxes for configuring the various
149   settings.
150
151 Support for doing tab-completion of email addresses
152
153   This support currently relies on an external program,
154   (notmuch-addresses), that is not yet shipped with notmuch
155   itself. But multiple, suitable implementations of this program have
156   already been written that generate address completions by doing
157   notmuch searches of your email collection. For example, providing
158   first those addresses that you have composed messages to in the
159   past, etc.
160
161   One such program (implemented in python with the python bindings to
162   notmuch) is available via:
163
164         git clone  http://jkr.acm.jhu.edu/git/notmuch_addresses.git
165
166   Install that program as notmuch-addresses on your PATH, and then
167   hitting TAB on a partial email address or name within the To: or Cc:
168   line of an email message will provide matching completions.
169
170 Support for file-based (Fcc) delivery of sent messages to mail store
171
172   This isn't yet enabled by default. To enable this, one will have to
173   set the "Notmuch Fcc Dirs" setting within the notmuch customize
174   screen, (see its documentation there for details). We anticipate
175   making this automatic in a future release.
176
177 New 'G' key binding to trigger mail refresh (G == "Get new mail")
178
179   The 'G' key works wherever '=' works. Before refreshing the screen
180   it calls an external program that can be used to poll email servers,
181   run notmuch new and setup specific tags for the new emails. The
182   script to be called should be configured with the "Notmuch Poll
183   Script" setting in the customize interface. This script will
184   typically invoke "notmuch new" and then perhaps several "notmuch
185   tag" commands.
186
187 Implement emacs message display with the JSON output from notmuch.
188
189   This is much more robust than the previous implementation, (where
190   some HTML mails and mail quoting the notmuch code with the delimiter
191   characters in it would cause the parser to fall over).
192
193 Better handling of HTML messages and MIME attachments (inline images!)
194
195   Allow for any MIME parts that emacs can display to be displayed
196   inline. This includes inline viewing of image attachments, (provided
197   the window is large enough to fit the image at its natural size).
198
199   Much more robust handling of HTML messages. Currently both text/plain
200   and text/html alternates will be rendered next to each other. In a
201   future release, users will be able to decide to see only one or the
202   other representation.
203
204   Each attachment now has its own button so that attachments can be
205   saved individually (the 'w' key is still available to save all
206   attachments).
207
208 Customizable support for tidying of text/plain message content
209
210   Many new functions are available for tidying up message
211   content. These include options such as wrapping long lines,
212   compressing duplicate blank lines, etc.
213
214   Most of these are disabled by default, but can easily be enabled by
215   clicking the available check boxes under the "Notmuch Show Insert
216   Text/Plain Hook" within the notmuch customize screen.
217
218 New support for searchable citations (even when hidden)
219
220   When portions of overly-long citations are hidden, the contents of
221   these citations will still be available for emacs' standard
222   "incremental search" functions. When the search matches any portion
223   of a hidden citation, the citation will become visible temporarily
224   to display the search result.
225
226 More flexible handling of header visibility
227
228   As an answer to complaints from many users, the To, Cc, and Date
229   headers of messages are no longer hidden by default. For those users
230   that liked that these were hidden, a new "Notmuch Messages Headers
231   Visible" option in the customize interface can be set to nil. The
232   visibility of headers can still be toggled on a per-message basis
233   with the 'h' keybinding.
234
235   For users that don't want to see some subset of those headers, the
236   new "Notmuch Message Headers" variable can be customized to list
237   only those headers that should be present in the display of a message.
238
239 The Return key now toggles message visibility anywhere
240
241   Previously this worked only on the first summary-line of a message.
242
243 Customizable formatting of search results
244
245   The user can easily customize the order, width, and formatting of
246   the various fields in a "notmuch search" buffer. See the "Notmuch
247   Search Result Format" section of the customize interface.
248
249 Generate nicer names for search buffers when using a saved search.
250
251 Add a notmuch User-Agent header when sending mail from notmuch/emacs.
252
253 New keybinding (M-Ret) to open all collapsed messages in a thread.
254
255 New library feature
256 -------------------
257 Provide a new NOTMUCH_SORT_UNSORTED value for queries
258
259   This can be somewhat faster when sorting simply isn't desired. For
260   example when collecting a set of messages that will all be
261   manipulated identically, (adding a tag, removing a tag, deleting the
262   messages), then there's no advantage to sorting the messages by
263   date.
264
265 Build fixes
266 -----------
267 Fix to compile against GMime 2.6
268
269   Previously notmuch insisted on being able to find GMime 2.4, (even
270   though GMime 2.6 would have worked all along).
271
272 Fix configure script to accept (and ignore) various standard options.
273
274   For example, those that the gentoo build scripts expect configure to
275   accept are now all accepted.
276
277 Test suite
278 ----------
279 A large number of new tests for the many new features.
280
281 Better display of output from failed tests.
282
283   Now shows failures with diff rather than forcing the user to gaze at
284   complete actual and expected output looking for deviation.
285
286 Notmuch 0.2 (2010-04-16)
287 ========================
288 This is the second release of the notmuch mail system, with actual
289 detailed release notes this time!
290
291 This release consists of a number of minor new features that make
292 notmuch more pleasant to use, and a few fairly major bug fixes.
293
294 We didn't quite hit our release target of "about a week" from the 0.1
295 release, (0.2 is happening 11 days after 0.1), but we hope to do
296 better for next week. Look forward to some major features coming to
297 notmuch in subsequent releases.
298
299 -Carl
300
301 General features
302 ----------------
303 Better guessing of From: header.
304
305   Notmuch now tries harder to guess which configured address should be
306   used as the From: line in a "notmuch reply". It will examine the
307   Received: headers if it fails to find any configured address in To:
308   or Cc:. This allows it to often choose the correct address even when
309   replying to a message sent to a mailing list, and not directly to a
310   configured address.
311
312 Make "notmuch count" with no arguments count all messages
313
314   Previously, it was hard to construct a search term that was
315   guaranteed to match all messages.
316
317 Provide a new special-case search term of "*" to match all messages.
318
319   This can be used in any command accepting a search term, such as
320   "notmuch search '*'". Note that you'll want to take care that the
321   shell doesn't expand * against the current files. And note that the
322   support for "*" is a special case. It's only meaningful as a single
323   search term and loses its special meaning when combined with any
324   other search terms.
325
326 Automatically detect thread connections even when a parent message is
327 missing.
328
329   Previously, if two or more message were received with a common
330   parent, but that parent was not received, then these messages would
331   not be recognized as belonging to the same thread. This is now fixed
332   so that such messages are properly connected in a thread.
333
334 General bug fixes
335 -----------------
336 Fix potential data loss in "notmuch new" with SIGINT
337
338   One code path in "notmuch new" was not properly handling
339   SIGINT. Previously, this could lead to messages being removed from
340   the database (and their tags being lost) if the user pressed
341   Control-C while "notmuch new" was working.
342
343 Fix segfault when a message includes a MIME part that is empty.
344
345 Fix handling of non-ASCII characters with --format=json
346
347   Previously, characters outside the range of 7-bit ASCII were
348   silently dropped from the JSON output. This led to corrupted display
349   of utf-8 content in the upcoming notmuch web-based frontends.
350
351 Fix headers to be properly decoded in "notmuch reply"
352
353   Previously, the user might see:
354
355         Subject: Re: =?iso-8859-2?q?Rozlu=E8ka?=
356
357   rather than:
358
359         Subject: Re: Rozlu─Źka
360
361   The former text is properly encoded to be RFC-compliant SMTP, will
362   be sent correctly, and will be properly decoded by the
363   recipient. But the user trying to edit the reply would likely be
364   unable to read or edit that field in its encoded form.
365
366 Emacs client features
367 ---------------------
368 Show the last few lines of citations as well as the first few lines.
369
370   It's often the case that the last sentence of a citation is what is
371   being replied to directly, so the last few lines are often much more
372   important. The number of lines shown at the beginning and end of any
373   citation can be configured, (notmuch-show-citation-lines-prefix and
374   notmuch-show-citation-lines-suffix).
375
376 The '+' and '-' commands in the search view can now add and remove
377 tags by region.
378
379   Selective bulk tagging is now possible by selecting a region of
380   threads and then using either the '+' or '-' keybindings. Bulk
381   tagging is still available for all threads matching the current
382   search with th '*' binding.
383
384 More meaningful buffer names for thread-view buffers.
385
386   Notmuch now uses the Subject of the thread as the buffer
387   name. Previously it was using the thread ID, which is a meaningless
388   number to the user.
389
390 Provide for customized colors of threads in search view based on tags.
391
392   See the documentation of notmuch-search-line-faces, (or us "M-x
393   customize" and browse to the "notmuch" group within "Applications"
394   and "Mail"), for details on how to configure this colorization.
395
396 Build-system features
397 ---------------------
398 Add support to properly build libnotmuch on Darwin systems (OS X).
399
400 Add support to configure for many standard options.
401
402   We include actual support for:
403
404         --includedir --mandir --sysconfdir
405
406   And accept and silently ignore several more:
407
408         --build --infodir --libexecdir --localstatedir
409         --disable-maintainer-mode --disable-dependency-tracking
410
411 Install emacs client in "make install" rather than requiring a
412 separate "make install-emacs".
413
414 Automatically compute versions numbers between releases.
415
416   This support uses the git-describe notation, so a version such as
417   0.1-144-g43cbbfc indicates a version that is 144 commits since the
418   0.1 release and is available as git commit "43cbbfc".
419
420 Add a new "make test" target to run the test suite and actually verify
421 its results.
422
423 Notmuch 0.1 (2010-04-05)
424 ========================
425 This is the first release of the notmuch mail system.
426
427 It includes the libnotmuch library, the notmuch command-line
428 interface, and an emacs-based interface to notmuch.
429
430 Note: Notmuch will work best with Xapian 1.0.18 (or later) or Xapian
431 1.1.4 (or later). Previous versions of Xapian (whether 1.0 or 1.1) had
432 a performance bug that made notmuch very slow when modifying
433 tags. This would cause distracting pauses when reading mail while
434 notmuch would wait for Xapian when removing the "inbox" and "unread"
435 tags from messages in a thread.