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