2 by William Morgan <wmorgan-sup@masanjin.net>
3 http://sup.rubyforge.org
7 Sup is a console-based email client for people with a lot of email.
8 It supports tagging, very fast full-text search, automatic contact-
9 list management, and more. If you're the type of person who treats
10 email as an extension of your long-term memory, Sup is for you.
13 - Handle massive amounts of email.
15 - Mix email from different sources: mbox files (even across different
16 machines), Maildir directories, IMAP folders, and GMail accounts.
18 - Instantaneously search over your entire email collection. Search over
19 body text, or use a query language to combine search predicates in any
22 - Handle multiple accounts. Replying to email sent to a particular
23 account will use the correct SMTP server, signature, and from address.
25 - Add custom code to customize Sup to whatever particular and bizarre
28 - Organize email with user-defined labels, automatically track recent
29 contacts, and much more!
31 The goal of Sup is to become the email client of choice for nerds
38 - Scalability to massive amounts of email. Immediate startup and
39 operability, regardless of how much amount of email you have.
41 - Immediate full-text search of your entire email archive, using the
42 Ferret query language. Search over message bodies, labels, from: and
43 to: fields, or any combination thereof.
45 - Thread-centrism. Operations are performed at the thread, not the
46 message level. Entire threads are manipulated and viewed (with
47 redundancies removed) at a time.
49 - Labels instead of folders. Drop that tired old metaphor and you'll see
50 how much easier it is to organize email.
52 - GMail-style thread management. Archive a thread, and it will disappear
53 from your inbox until someone replies. Kill a thread, and it will
54 never come back to your inbox (but will still show up in searches.)
55 Mark a thread as spam and you'll never again see it unless explicitly
58 - Console based interface. No mouse clicking required!
60 - Programmability. It's in Ruby. The code is good. It has an extensive
61 hook system that makes it easy to extend and customize.
63 - Multiple buffer support. Why be limited to viewing one thing at a
66 - Tons of other little features, like automatic context-sensitive help,
67 multi-message operations, MIME attachment viewing, recent contact list
70 Current limitations which will be fixed:
72 - Sup doesn't play nicely with other mail clients. If you alter a mail
73 source (read, move, delete, etc) with another client Sup will punish
74 you with a lengthy reindexing process.
76 - Support for mbox, Maildir, and IMAP only at this point. No support for
79 - IMAP support is very slow due mostly to Ruby's IMAP library. You may
80 consider something like offlineimap to mirror your IMAP folders with
83 - Unix-centrism in MIME attachment handling and in sendmail invocation.
90 Note that Sup never changes the contents of any mailboxes; it only
91 indexes in to them. So it shouldn't ever corrupt your mail. The flip
92 side is that if you change a mailbox (e.g. delete messages, or, in the
93 case of mbox files, read an unread message) then Sup will be unable to
94 load messages from that source and will ask you to run sup-sync
116 See FAQ.txt for some common problems and their solutions.
120 Copyright (c) 2006--2009 William Morgan.
122 This program is free software; you can redistribute it and/or
123 modify it under the terms of the GNU General Public License
124 as published by the Free Software Foundation; either version 2
125 of the License, or (at your option) any later version.
127 This program is distributed in the hope that it will be useful,
128 but WITHOUT ANY WARRANTY; without even the implied warranty of
129 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
130 GNU General Public License for more details.
132 You should have received a copy of the GNU General Public License
133 along with this program; if not, write to the Free Software
134 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA