1 |
.TH IMAPFILTER 1 "7 August 2001" "Version 0.1" Commands |
2 |
.SH NAME |
3 |
imapfilter - mail filter |
4 |
.SH SYNOPSIS |
5 |
.B imapfilter |
6 |
.RB [ -qtvL ] |
7 |
.RB [ -c |
8 |
.IR configfile ] |
9 |
.RB [ -l |
10 |
.IR logfile ] |
11 |
.SH DESCRIPTION |
12 |
.B imapfilter |
13 |
is a mail filtering utility. It connects to remote mail servers using the |
14 |
Internet Message Access Protocol (IMAP) and deletes messages according to |
15 |
defined filter rules. It is purposed as a preconnect utility before user |
16 |
accesses his/her mailbox (eg. fetch mail). In that way it "clears" user's |
17 |
mailbox from any unwanted messages, without having to download even a single |
18 |
header line of them. |
19 |
.SH OPTIONS |
20 |
.TP |
21 |
.B -c configfile |
22 |
Configuration file to read settings and filters from. The default is |
23 |
.IR $HOME/.imapfilterrc . |
24 |
.TP |
25 |
.B -l logfile |
26 |
File that contains logs of any mail deletion and error messages that |
27 |
.B imapfilter |
28 |
produces. The default is |
29 |
.IR $HOME/.imapfilter_log . |
30 |
.TP |
31 |
.B -q |
32 |
Be quite; don't print any information at all. |
33 |
.TP |
34 |
.B -t |
35 |
Enables test mode, in which the program works as before, but just doesn't |
36 |
delete any messages on remote mailbox. |
37 |
.TP |
38 |
.B -v |
39 |
Be verbose; print detailed information about the program's actions. |
40 |
.TP |
41 |
.B -L |
42 |
Disable logging of any information to file. |
43 |
.SH CONFIGURATION FILE |
44 |
The configuration file has the following format: |
45 |
.PP |
46 |
Empty lines and lines beginning with '#' are considered comments. |
47 |
.PP |
48 |
Otherwise a line is in the format "KEYWORD = ARGUMENT" for account settings |
49 |
and "DENY = HEADER" for the filters. |
50 |
.PP |
51 |
The available keywords are: |
52 |
.TP |
53 |
.B SERVER |
54 |
Hostname of the mailserver on which to connect. |
55 |
.TP |
56 |
.B PORT |
57 |
TCP/IP port to connect on to remote server. If not provided the default IMAP |
58 |
protocol port (ie. port 143) will be used. |
59 |
.TP |
60 |
.B USERNAME |
61 |
User's name to be used while logging in to server. |
62 |
.TP |
63 |
.B PASSWORD |
64 |
Password of the user. |
65 |
.TP |
66 |
.B LOGFILE |
67 |
Log file to save filtering information and error messages. |
68 |
.TP |
69 |
.B DENY |
70 |
The HEADER is comprised by FIELD-NAME and FIELD-BODY, with the two seperated |
71 |
with an optional ':' character and |
72 |
.B only |
73 |
one space. |
74 |
|
75 |
The FIELD-NAME should be one of FROM, TO, CC, BCC, SUBJECT or a user specified |
76 |
header field-name. The FIELD-BODY is a string. Messages that have a header |
77 |
with the defined FIELD-NAME and contain the FIELD-BODY match the DENY filter |
78 |
and are being deleted. The matching is case-insensitive. |
79 |
.SH CONFIGURATION EXAMPLES |
80 |
See |
81 |
.IR sample.imapfilterrc . |
82 |
.SH ENVIROMENT |
83 |
.TP |
84 |
.B HOME |
85 |
User's home directory. |
86 |
.SH FILES |
87 |
.TP |
88 |
.I $HOME/.imapfilterrc |
89 |
Default configuration file. |
90 |
.TP |
91 |
.I $HOME/.imapfilter_log |
92 |
Default log file. |
93 |
.SH CONFORMING TO |
94 |
.TP |
95 |
IMAP4rev1: |
96 |
RFC 2060 |
97 |
.SH AUTHOR |
98 |
Lefteris Chatzibarbas <lefcha@hol.gr> |