8460123db3770c59a49b690cee546f42cf538e46
[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 3. Allow an easy way to remove excess tags, (date-based search)
8
9 4. Make emacs fast for big search results (see "lazy searching" below)
10
11 5. Fix Xapian defect #250 so tagging is fast.
12
13 Emacs interface (notmuch.el)
14 ----------------------------
15 Make the keybindings help ('?') display the summary of each command's
16 documentation, not the function name.
17
18 Add a global keybinding table for notmuch, and then view-specific
19 tables that add to it.
20
21 Add a command to archive all threads in a search view.
22
23 Lazy searching: call "notmuch search" with --first and --max to fill
24 just a screenful of results, and then fill in more as ther user pages
25 through the buffer.
26
27 Add a '|' binding from the search view.
28
29 Add a binding to run a search from notmuch-show-mode.
30
31 When a thread has been entirely read, start out by closing all
32 messages except those that matched the search terms.
33
34 Add support for choosing from one of the user's configured email
35 addresses for the From line.
36
37 Make 'notmuch-show-pipe-message have a private history.
38
39 Portability
40 -----------
41 Fix configure script to test each compiler warning we want to use.
42
43 Implement strndup locally (or call talloc_strndup instead).
44
45 Implement getline locally, (look at gnulib).
46
47 Completion
48 ----------
49 Fix bash completion to complete multiple search options (both --first
50 and *then* --max-threads), and also complete value for --sort=
51 (oldest-first or newest-first).
52
53 notmuch command-line tool
54 -------------------------
55 Teach "notmuch search" to return many different kinds of results. Some
56 ideas:
57
58         notmuch search --for threads    # Default if no --for is given
59         notmuch search --for messages
60         notmuch search --for tags
61         notmuch search --for addresses
62         notmuch search --for terms
63
64 Add a "--format" option to "notmuch search", (something printf-like
65 for selecting what gets printed).
66
67 Add a "--count-only" (or so?) option to "notmuch search" for returning
68 the count of search results.
69
70 Give "notmuch restore" some progress indicator. Until we get the
71 Xapian bugs fixed that are making this operation slow, we really need
72 to let the user know that things are still moving.
73
74 Fix notmuch.c to call add_timestamp/get_timestamp with path names
75 relative to the database path. (Otherwise, moving the database to a
76 new directory will result in notmuch creating new timestamp documents
77 and leaving stale ones behind.)
78
79 Ensure that "notmuch new" is sane if its first, giant indexing session
80 gets interrupted, (that is, ensure that any results indexed so far are
81 flushed).
82
83 Fix notmuch.c to use a DIR prefix for directory timestamps, (the idea
84 being that it can then add other non-directory timestamps such as for
85 noting how far back in the past mail has been indexed, and whether it
86 needs to re-tag messages based on a theoretical "auto-tags"
87 configuration file).
88
89 Make "notmuch new" notice when a mail directory has gone more than a
90 month without receiving new mail and use that to trigger the printing
91 of the note that the user might want to mark the directory read-only.
92
93 Also make "notmuch new" optionally able to just mark those month-old
94 directories read-only on its own. (Could conflict with low-volume
95 lists such as announce lists if they are setup to deliver to their own
96 maildirs.)
97
98 notmuch library
99 ---------------
100 Add support for files that are moved or deleted (which obviously need
101 to be handled differently).
102
103 Actually compile and install a libnotmuch shared library.
104
105 Fix to use the *last* Message-ID header if multiple such headers are
106 encountered, (I noticed this is one thing that kept me from seeing the
107 same message-ID values as sup).
108
109 Add support for the user to specify custom headers to be indexed.
110
111 Add support for automatic tagging of new messages based on particular
112 search criteria, (likely using an InMemory database for the new
113 messages).
114
115 General
116 -------
117 Audit everything for dealing with out-of-memory (and drop xutil.c).
118
119 Write a test suite.
120
121 Achieve 100% test coverage with the test suite.
122
123 Investigate why the notmuch database is slightly larger than the sup
124 database for the same corpus of email.