]> git.notmuchmail.org Git - notmuch/blob - TODO
configure: Remove a debugging print message.
[notmuch] / TODO
1 Fix the things that are causing the most pain to new users
2 ----------------------------------------------------------
3 1. A new import is tagging all messages as "inbox" -- total pain
4
5 2. Allow an easy way to get tags from directory names (if the user has them)
6
7 Emacs interface (notmuch.el)
8 ----------------------------
9 Switch the notmuch-search view to use "notmuch search --format=json"
10 to fix large classes of bugs regarding poorly-escaped output and lame
11 regular expressions. (The most recently found, unfixed example is the
12 sender's name containing ';' which causes emacs to drop a search
13 result.) This may require removing the outer array from the current
14 "notmuch search --format=json" results.
15
16 Fix '*' to work by simply calling '+' or '-' on a region consisting of
17 the entire buffer.
18
19 Add a global keybinding table for notmuch, and then view-specific
20 tables that add to it.
21         
22 Add a '|' binding from the search view.
23
24 Add support for choosing from one of the user's configured email
25 addresses for the From line.
26
27 Make 'notmuch-show-pipe-message have a private history.
28
29 Add support for a delete keybinding that adds a "deleted" tag to the
30 current message/thread and make searches not return deleted messages
31 by default, (unless the user asks explicitly for deleted messags in
32 the search query).
33
34 Add support to "mute" a thread (add a "muted" tag and then don't
35 display threads in searches by default where any message of the thread
36 has the "muted" tag).
37
38 Make '=' count from the end rather than from the beginning if more
39 than half-way through the buffer.
40
41 Fix to automatically wrap long headers (for RFC compliance) before
42 sending. This should probably just be fixed in message-mode itself,
43 (but perhaps we can have a notmuch-message-mode that layers this on
44 top).
45
46 Stop hiding the headers so much in the thread-view mode.
47
48 Allow opening a message in thread-view mode by clicking on either
49 line.
50
51 Automatically open a message when navigating to it with N or P.
52
53 Change 'a' command in thread-view mode to only archive open messages.
54
55 Add a binding to open all closed messages.
56
57 Change the 'a'rchive command in the thread view to only archive open
58 messages.
59
60 Completion
61 ----------
62 Fix bash completion to complete multiple search options (both --first
63 and *then* --max-threads), and also complete value for --sort=
64 (oldest-first or newest-first).
65
66 notmuch command-line tool
67 -------------------------
68 Replace "notmuch reply" with "notmuch compose --reply <search-terms>".
69 This would enable a plain "notmuch compose" to be used to construct an
70 initial message, (which would then have the properly configured name
71 and email address in the From: line. We could also then easily support
72 "notmuch compose --from <something>" to support getting at alternate
73 email addresses.
74
75 Fix the --format=json option to not imply --entire-thread.
76
77 Implement "notmuch search --exclude-threads=<search-terms>" to allow
78 for excluding muted threads, (and any other negative, thread-based
79 filtering that the user wants to do).
80
81 Fix "notmuch show" so that the UI doesn't fail to show a thread that
82 is visible in a search buffer, but happens to no longer match the
83 current search. (Perhaps add a --matching=<secondary-search-terms>
84 option (or similar) to "notmuch show".) For now, this is being worked
85 around in the emacs interface by noticing that "notmuch show" returns
86 nothing and re-rerunning the command without the extra arguments.
87
88 Add a "--format" option to "notmuch search", (something printf-like
89 for selecting what gets printed).
90
91 Give "notmuch restore" some progress indicator.
92
93 Fix "notmuch restore" to operate in a single pass much like "notmuch
94 dump" does, rather than doing N searches into the database, each
95 matching 1/N messages.
96
97 Add a "-f <filename>" option to select an alternate configuration
98 file.
99
100 Allow configuration for filename patterns that should be ignored when
101 indexing.
102
103 Replace the "notmuch part --part=id" command with "notmuch show
104 --part=id", (David Edmonson wants to rewrite some of "notmuch show" to
105 provide more MIME-structure information in its output first).
106
107 Replace the "notmuch search-tags" command with "notmuch search
108 --output=tags".
109
110 Fix to avoid this ugly message:
111
112         (process:17197): gmime-CRITICAL **: g_mime_message_get_mime_part: assertion `GMIME_IS_MESSAGE (message)' failed
113         Warning: Not indexing empty mime part.
114
115   This probably means adding a test case to generate that message,
116   filing an upstream bug against GMime, and then silencing the
117   notmuch-generated portion of the warning (so that once GMime is
118   fixed, this is all silent).
119
120 Simplify notmuch-reply to simply print the headers (we have the
121 original values) rather than calling GMime (which encodes) and adding
122 the confusing gmime-filter-headers.c code (which decodes).
123
124 notmuch library
125 ---------------
126 Add an interface to accept a "key" and a byte stream, rather than a
127 filename.
128
129 Provide a sane syntax for date ranges. First, we don't want to require
130 both endpoints to be specified. For example it would be nice to be
131 able to say things like "since:2009-01-1" or "until:2009-01-1" and
132 have the other endpoint be implicit. Second we'd like to support
133 relative specifications of time such as "since:'2 months ago'". To do
134 any of this we're probably going to need to break down an write our
135 own parser for the query string rather than using Xapian's QueryParser
136 class.
137
138 Make failure to read a file (such as a permissions problem) a warning
139 rather than an error (should be similar to the existing warning for a
140 non-mail file).
141
142 Fix to use the *last* Message-ID header if multiple such headers are
143 encountered, (I noticed this is one thing that kept me from seeing the
144 same message-ID values as sup).
145
146 Add support for configuring "virtual tags" which are a tuple of
147 (tag-name, search-specification). The database is responsible for
148 ensuring that the virtual tag is always consistent.
149
150 Indicate to the user if two files with the same message ID have
151 content that is actually different in some interesting way. Perhaps
152 notmuch initially sees all changes as interesting, and quickly learns
153 from the user which changes are not interesting (such as the very
154 common mailing-list footer).
155
156 Fix notmuch_query_count_messages to share code with
157 notmuch_query_search_messages rather than duplicating code. (And
158 consider renaming it as well.)
159
160 Provide a mechanism for doing automatic address completion based on
161 notmuch searches. Here was one proposal made in IRC:
162
163         <cworth> I guess all it would really have to be would be a way
164                  to configure a series of searches to try in turn,
165                  (presenting ambiguities at a given single level, and
166                  advancing to the next level only if one level
167                  returned no matches).
168         <cworth> So then I might have a series that looks like this:
169         <cworth> notmuch search --output=address_from tag:address_book_alias
170         <cworth> notmuch search --output=address_to tag:sent
171         <cworth> notmuch search --output=address_from
172         <cworth> I think I might like that quite a bit.
173         <cworth> And then we have a story for an address book for
174                  non-emacs users.
175
176 Provide a ~me Xapian synonym for all of the user's configured email
177 addresses.
178
179 Add symbol hiding so that we don't risk leaking any private symbols
180 into the shared-library interface.
181
182 Audit all libnotmuch entry points to ensure that all Xapian calls are
183 wrapped in a try/catch block.
184
185 Fix the "count" functionality to be exact as Olly explained in IRC:
186
187         ojwb> cworth: if you set the check_at_least parameter to the
188         database size, get_matches_estimated() will be exact
189
190 Search syntax
191 -------------
192 Implement support for "tag:*" to expand to all tags.
193
194 Fix "notmuch search to:" to be less confusing. Many users expect this
195 to search for all messages with a To: header, but it instead searches
196 for all messages with the word "to". If we don't provide the first
197 behavior, perhaps we should exit on an error when a configured prefix
198 is provided with no value?
199
200 Support "*" in all cases and not just as a special case. That is, "* "
201 should also work, as well as "* and tag:inbox".
202
203 Implement a syntax for requesting set-theoertic operations on results
204 of multiple searches. For example, I would like to do:
205
206         "tag:inbox" SET-SUBTRACT "tag:muted"
207
208     as well as:
209
210         "tag:notmuch and <date-range>" SET-INTERSECT
211         "tag:notmuch and not (tag:merged or tag:postponed)"
212
213     See id:3wdpr282yz2.fsf@testarossa.amd.com for more details on the
214     use cases of the above.
215
216 Database changes
217 ----------------
218 Store a reference term for every message-id that appears in
219 References. We just started doing this for newly-added documents, but
220 at the next convenient database-schema upgrade, we should go back and
221 fix old messages to be consistent.
222
223 Start indexing the List-Id header, (and re-index this header for
224 existing messages at the next database upgrade).
225
226 Start indexing the message file's directory and make it available for
227 search as "folder:" (and re-index this value for existing messages at
228 the next database upgrade).
229
230 Add support for the user to specify custom headers to be indexed (and
231 re-index these for existing messages at the next database upgrade).
232
233 Test suite
234 ----------
235 Achieve 100% test coverage with the test suite.
236
237 General
238 -------
239 Audit everything for dealing with out-of-memory (and drop xutil.c).
240
241 Investigate why the notmuch database is slightly larger than the sup
242 database for the same corpus of email.
243
244 Makefile should print message teaching user about LD_LIBRARY_PATH (or
245 similar) if libdir is not set to a directory examined by ldconfig.