== DESCRIPTION:
-Sup is an attempt to take the UI innovations of web-based email
-readers (ok, really just GMail) and to combine them with the
-traditional wholesome goodness of a console-based email client.
+Sup is a console-based email client for people with a lot of email.
+It supports tagging, very fast full-text search, automatic contact-
+list management, and more. If you're the type of person who treats
+email as an extension of your long-term memory, Sup is for you.
-Sup is designed to work with massive amounts of email, potentially
-spread out across different mbox files, IMAP folders, and GMail
-accounts, and to pull them all together into a single interface.
+Sup makes it easy to:
+- Handle massive amounts of email.
+
+- Mix email from different sources: mbox files (even across different
+ machines), Maildir directories, IMAP folders, POP accounts, and
+ GMail accounts.
+
+- Instantaneously search over your entire email collection. Search
+ over body text, or use a query language to combine search
+ predicates in any way.
+
+- Handle multiple accounts. Replying to email sent to a particular
+ account will use the correct SMTP server, signature, and from
+ address.
+
+- Add custom code to handle certain types of messages or to handle
+ certain types of text within messages.
+
+- Organize email with user-defined labels, automatically track
+ recent contacts, and much more!
The goal of Sup is to become the email client of choice for nerds
everywhere.
- Scalability to massive amounts of email. Immediate startup and
operability, regardless of how much amount of email you have.
- (At least, once everything's been indexed.)
-- Immediate full-text search of your entire email archive, using
- the full Ferret query langauge. Search over message bodies, labels,
- from: and to: fields, or any combination thereof.
+- Immediate full-text search of your entire email archive, using the
+ Ferret query language. Search over message bodies, labels, from: and
+ to: fields, or any combination thereof.
- Thread-centrism. Operations are performed at the thread, not the
message level. Entire threads are manipulated and viewed (with
- Labels instead of folders. Drop that tired old metaphor and you'll
see how much easier it is to organize email.
-- GMail-style thread management. Archive a thread, and it will
- disappear from your inbox until someone replies. Kill a thread, and
- it will never come back to your inbox. (But it will still show up in
- searches, of course.)
+- GMail-style thread management (but better!). Archive a thread, and
+ it will disappear from your inbox until someone replies. Kill a
+ thread, and it will never come back to your inbox (but will still
+ show up in searches.) Mark a thread as spam and you'll never again
+ see it unless explicitly searching for spam.
- Console based interface. No mouse clicking required!
Current limitations which will be fixed:
-- Support for mbox and IMAP only at this point. No support for POP, mh,
- or GMail mailstores.
+- Support for mbox, remote mbox, and IMAP only at this point. No
+ support for POP, mh, or GMail mailstores.
- No internationalization support. No wide characters, no subject
demangling.
- Unix-centrism in MIME attachment handling and in sendmail
invocation.
-- Several obvious missing features, like undo, filters / saved
+- Several obvious missing features, like filters / saved
searches, message annotations, etc.
== SYNOPSYS:
- 1. sup-import <source>+
- 2. sup
- 3. edit ~/.sup/config.yaml for the (very few) settings sup has
-
- Where <source> is a filename (for mbox files), or an imap or imaps
- url. In the case of imap, don't put the username and password in
- the URI (which is a terrible, terrible idea). You will be prompted
- for them.
-
- sup-import has several options which control whether you want
- messages from particular mailboxes not to be added to the inbox,
- or not to be marked as new, so run it with -h for help.
+ 0. sup-config
+ 1. sup
Note that Sup never changes the contents of any mailboxes; it only
indexes in to them. So it shouldn't ever corrupt your mail. The flip
side is that if you change a mailbox (e.g. delete messages, or, in
- the case of mbox files, read an unread message) then Sup may crash,
- and will tell you to run sup-import --rebuild to recalculate the
- offsets within the mailbox.
+ the case of mbox files, read an unread message) then Sup will be
+ unable to load messages from that source and will ask you to run
+ sup-sync --changed.
== REQUIREMENTS:
* ferret >= 0.10.13
-* ncurses >= 0.9.1
-* rmail >= 0.17
+* ncurses
+* rmail
+* highline
+* net-ssh
+* trollop >= 1.7
+* lockfile
+* mime-types
== INSTALL:
-* gem install sup -y
-* Then, in rmail, change line 159 of multipart.rb to:
- chunk = chunk[0..start]
- (Sorry; it's an unsupported package.) You might be able to get away
- without doing this but if you get frozen string exceptions when
- reading in multipart messages, this is what you need to change.
+* gem install sup
+
+== PROBLEMS:
+
+See FAQ.txt for some common problems and their solutions.
== LICENSE:
-Copyright (c) 2006 William Morgan.
+Copyright (c) 2006--2009 William Morgan.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
projects / sup / blobdiff