2
.TH MAILINSPECT 1 "Bayesian Text Classification Tools" "Version @VERSION@" ""
4
mailinspect \- sort an mbox by category and pipe emails to a command.
24
reads the single mbox folder named FILE and sorts it in order of similarity to
30
It can be used as a command line tool or interactively, when given the
34
When used as a command line tool,
36
prints the sorted list of emails on STDOUT. Each line consists of a
37
seek position for the given email within FILE, followed by the score and a description
38
string in one of several styles chosen via the
44
string in conjunction with the
48
spawns a shell and executes
50
for every email in FILE (possibly selected via the
52
options), in the sorted order. This is similar to the
54
functionality, except the latter doesn't order the emails.
56
In interactive mode, all the command line functionality is available via
57
keypresses. The sorted list of emails is displayed in a scrollable format,
58
and can be viewed, searched, tagged, resorted and sent to shell commands. Predefined
59
shell commands can be associated with function keys. See the usage section below.
61
The sorting heuristics are currently (and may always be) experimental,
62
so there is no guarantee that the orderings are particularly well suited
67
returns 1 on success, 0 if some error occurred.
72
to compute the scores and sort the emails, which
73
should be the file name of a
77
Only emails matching the regular expression
79
are sorted. All other emails are ignored. When several
83
options are present on the command line,
84
earlier regular expressions are overridden
85
by later ones where applicable.
87
Force internationalized mode.
89
Force regular expression searches to be case sensitive.
91
Determines the scoring formula to be used. The parameter
93
must be an integer greater than or equal to zero. By default,
97
Prints the email index in the given style. The parameter
99
must be an integer greater than or equal to zero. By default,
103
For each email in the list, execute the shell
105
with the email body on STDIN. Emails are processed in sorted order.
107
Reverse sort order. Normally, emails are sorted in order of closest
108
to furthest relative to
110
but in this case, the opposite is true.
112
Interactive mode. Instead of printing the sorted list of emails
113
on STDOUT, emails are displayed and can be scrolled, viewed,
114
searched and piped interactively at the terminal.
118
matching the regular expression
120
are sorted. Opposite of
124
Print the program version number and exit.
128
needs to read a prelearned
130
before it can sort the emails in FILE. See
133
Suppose you have two mail folders named
137
respectively. You can create appropriate categories by typing the commands
140
% dbacl -l good good.mbox -T email
142
% dbacl -l bad bad.mbox -T email
145
Next, you can type the following command to view interactively the
147
file with the emails whose score is closest to the category
152
% mailinspect -I -c good bad.mbox
155
Alternatively, you might be interested only in the five emails in the folder
157
whose score marks them as the furthest away from the category
159
completely independently from any other category such as
161
(ie you want outliers in the scoring sense).
164
% mailinspect -z -c bad bad.mbox | head -5
167
In interactive mode, the following keys are defined:
169
toggles another scoring formula.
171
toggles another display style.
176
sends the currently highlighted email to a shell command.
178
sends all currently tagged emails to a shell command, in sorted order.
179
Every email executes the shell command independently.
181
tags the currently highlighted email.
183
tags all listed emails.
185
sends the currently highlighted email to $PAGER for viewing. If the environment
186
variable PAGER is not defined, sends the email to
189
untags the highlighted email.
191
untags all listed emails.
193
reverses the sort order of displayed emails.
195
searches for a regular expression (see
197
anywhere within the contents of all listed emails. Hides all emails
200
like /, but hides all emails which match, keeping all those which don't match.
202
As a convenience, the function keys F1-F10 can each be associated
203
with a shell command string. In this
204
case, typing a function key has the same effect as the S key, but the command is
205
already typed and ready to be edited/accepted.
206
The function key associations are read from the configuration file .mailinspectrc
210
.IP $HOME/.mailinspectrc
212
reads the file .mailinspectrc in the $HOME directory, if it exists.
213
This is a plain text file which contains entries of the form
218
F2 cat >> interesting.mbox
220
F5 mail zarniwoop@megadodo.com
225
When this variable is set, its value is prepended to every
227
filename which doesn't start with a '/'.
230
The source code for the latest version of this program is available at the
234
http://www.lbreyer.com/gpl.html
236
http://dbacl.sourceforge.net
240
Laird A. Breyer <laird@lbreyer.com>
added
removed
man/mailinspect.1in
