2 by William Morgan <wmorgan-sup@masanjin.net>
3 http://sup.rubyforge.org
7 Sup is an attempt to take the UI innovations of web-based email
8 readers (ok, really just GMail) and to combine them with the
9 traditional wholesome goodness of a console-based email client.
11 Sup is designed to work with massive amounts of email, potentially
12 spread out across different mbox files, IMAP folders, and GMail
13 accounts, and to pull them all together into a single interface.
15 The goal of Sup is to become the email client of choice for nerds
22 - Scalability to massive amounts of email. Immediate startup and
23 operability, regardless of how much amount of email you have.
24 (At least, once everything's been indexed.)
26 - Immediate full-text search of your entire email archive, using
27 the full Ferret query langauge. Search over message bodies, labels,
28 from: and to: fields, or any combination thereof.
30 - Thread-centrism. Operations are performed at the thread, not the
31 message level. Entire threads are manipulated and viewed (with
32 redundancies removed) at a time.
34 - Labels instead of folders. Drop that tired old metaphor and you'll
35 see how much easier it is to organize email.
37 - GMail-style thread management. Archive a thread, and it will
38 disappear from your inbox until someone replies. Kill a thread, and
39 it will never come back to your inbox. (But it will still show up in
42 - Console based interface. No mouse clicking required!
44 - Programmability. It's in Ruby. The code is good. It's easy to
47 - Multiple buffer support. Why be limited to viewing one thread at a
50 - Tons of other little features, like automatic context-sensitive
51 help, multi-message operations, MIME attachment viewing, recent
52 contact list generation, etc.
54 Current limitations which will be fixed:
56 - Support for mbox only at this point. No support for POP, IMAP, mh,
59 - No internationalization support. No wide characters, no subject
62 - Unix-centrism in MIME attachment handling and in sendmail
65 - Several obvious missing features, like undo, filters / saved
66 searches, message annotations, etc.
70 1. sup-import <mbox filename>+
72 3. edit ~/.sup/config.yaml for the (very few) settings sup has
74 sup-import has several options which control whether you want
75 messages from particular mailboxes not to be added to the inbox,
76 or not to be marked as new, so run it with -h for help.
78 Note that Sup never changes the contents of any mailboxes; it only
79 indexes in to them. So it shouldn't ever corrupt your mail. The flip
80 side is that if you change a mailbox (e.g. delete messages, or, in
81 the case of mbox files, read an unread message) then Sup may crash,
82 and will tell you to run sup-import --rebuild to recalculate the
83 offsets within the mailbox.
94 * Then, in rmail, change line 159 of multipart.rb to:
95 chunk = chunk[0..start]
96 (Sorry. it's an unsupported package.) You might be able to get away
97 without doing this but if you get frozen string exceptions when
98 reading in multipart messages, this is what you need to change.
102 Copyright (c) 2006 William Morgan.
104 This program is free software; you can redistribute it and/or
105 modify it under the terms of the GNU General Public License
106 as published by the Free Software Foundation; either version 2
107 of the License, or (at your option) any later version.
109 This program is distributed in the hope that it will be useful,
110 but WITHOUT ANY WARRANTY; without even the implied warranty of
111 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
112 GNU General Public License for more details.
114 You should have received a copy of the GNU General Public License
115 along with this program; if not, write to the Free Software
116 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA