forked from shenson/sup
/
README.txt
136 lines (96 loc) · 4.36 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
sup
by William Morgan <wmorgan-sup@masanjin.net>
http://sup.rubyforge.org
== DESCRIPTION:
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 makes it easy to:
- Handle massive amounts of email.
- Mix email from different sources: mbox files (even across different
machines), Maildir directories, IMAP folders, 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 customize Sup to whatever particular and bizarre
needs you may have.
- 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.
== FEATURES/PROBLEMS:
Features:
- Scalability to massive amounts of email. Immediate startup and
operability, regardless of how much amount of email you have.
- 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
redundancies removed) at a time.
- 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 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!
- Programmability. It's in Ruby. The code is good. It has an extensive
hook system that makes it easy to extend and customize.
- Multiple buffer support. Why be limited to viewing one thing at a
time?
- Tons of other little features, like automatic context-sensitive help,
multi-message operations, MIME attachment viewing, recent contact list
generation, etc.
Current limitations which will be fixed:
- Sup doesn't play nicely with other mail clients. If you alter a mail
source (read, move, delete, etc) with another client Sup will punish
you with a lengthy reindexing process.
- Support for mbox, Maildir, and IMAP only at this point. No support for
POP or mh.
- IMAP support is very slow due mostly to Ruby's IMAP library. You may
consider something like offlineimap to mirror your IMAP folders with
local Maildir ones.
- Unix-centrism in MIME attachment handling and in sendmail invocation.
== SYNOPSYS:
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 will be unable to
load messages from that source and will ask you to run sup-sync
--changed.
== REQUIREMENTS:
- ferret >= 0.11.6
- ncurses >= 0.9.1
- rmail >= 0.17
- highline
- net-ssh
- trollop >= 1.12
- lockfile
- mime-types
- gettext
- fastthread
== INSTALL:
* gem install sup
== PROBLEMS:
See FAQ.txt for some common problems and their solutions.
== LICENSE:
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
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.