imapfilter/imapfilter/imapfilter.1

.TH IMAPFILTER 1 "21 August 2001" "Version 0.2" Commands
.SH NAME
imapfilter - mail filter
.SH SYNOPSIS
.B imapfilter
.RB [ -hqstv ]
.RB [ -c
.IR configfile ]
.RB [ -l
.IR logfile ]
.SH DESCRIPTION
.B imapfilter
is a mail filtering utility. It connects to remote mail servers using the
Internet Message Access Protocol (IMAP) and deletes messages according to
defined filter rules. It is purposed as a preconnect utility before user
accesses his/her mailbox (eg. fetch mail). In that way it "clears" user's
mailbox from any unwanted messages, without having to download even a single
header line of them.
.SH OPTIONS
.TP
.B -c configfile
Configuration file to read settings and filters from. The default is
.IR $HOME/.imapfilterrc .
.TP
.B -h
Prints a summary of program's options.
.TP
.B -l logfile
File that contains logs of error messages
.B imapfilter
produces and optionally, if the
.B -s
option is given, information about the deleted messages.
.TP
.B -q
Be quite; don't print any information at all.
.TP
.B -s
Show some of the headers (specifically Date, From and Subject) of the deleted
messages.
.TP
.B -t
Enables test mode, in which the program works as before, but just doesn't
delete any messages on remote mailbox.
.TP
.B -v
Be verbose; print detailed information about the program's actions.
.SH CONFIGURATION FILE
.PP
The configuration file has the following format:
.PP
Empty lines and lines beginning with '#' are considered comments.
.PP
Otherwise a line is in the format "KEYWORD = ARGUMENT" for account settings,
"FILTER = HEADER" for the filters entries, and "LIMIT = SIZE" for the message
limits.
.PP
The available keywords are:
.TP
.B SERVER
Hostname of the mailserver on which to connect.
.TP
.B PORT
TCP/IP port to connect on to remote server. If not provided the default IMAP
protocol port (ie. port 143) will be used.
.TP
.B USERNAME
User's name to be used while logging in to server.
.TP
.B PASSWORD
Password of the user.
.TP
.B LOGFILE
Log file to save filtering information and error messages.
.PP
Filter entries are:
.TP
.B DENY
Remove all messages that match the defined HEADER.
.TP
.B ALLOW
Override all DENY filters and define exceptions, according to which
messages will not be deleted.  If no DENY filters where defined, then
.B everything
is deleted except the ALLOW filters.
.PP
The HEADER is comprised by FIELD-NAME and FIELD-BODY, with the two seperated
with an optional ':' character and
.B only
one space.

The FIELD-NAME should be one of FROM, TO, CC, BCC, SUBJECT or a user specified
header field-name. The FIELD-BODY is a string. Messages that have a header
with the defined FIELD-NAME and contain the FIELD-BODY match the DENY filter
and are being deleted. The matching is case-insensitive.
.PP
Message limits are:
.TP
.B DENY_LIMIT
All messages, except those that match the ALLOW filters, with size in octets
(bytes) greater than the supplied, are deleted.
.TP
.B ALLOW_LIMIT
Size limit for messages that match the ALLOW filters, in other words, messages
that the DENY_LIMIT cannot filter.
.SH CONFIGURATION EXAMPLES
See
.IR sample.imapfilterrc .
.SH FILES
.TP
.I $HOME/.imapfilterrc
Default configuration file.
.SH ENVIROMENT
.TP
.B HOME
User's home directory.
.SH CONFORMING TO
.TP
IMAP4rev1:
RFC 2060
.SH AUTHOR
Lefteris Chatzibarbas <lefcha@users.sourceforge.net>
1	lefcha	1.4	.TH IMAPFILTER 1 "21 August 2001" "Version 0.2" Commands
2	lefcha	1.1	.SH NAME
3			imapfilter - mail filter
4			.SH SYNOPSIS
5			.B imapfilter
6	lefcha	1.3	.RB [ -hqstv ]
7	lefcha	1.1	.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	lefcha	1.2	.B -h
26	lefcha	1.3	Prints a summary of program's options.
27	lefcha	1.2	.TP
28	lefcha	1.1	.B -l logfile
29	lefcha	1.3	File that contains logs of error messages
30	lefcha	1.1	.B imapfilter
31	lefcha	1.3	produces and optionally, if the
32			.B -s
33			option is given, information about the deleted messages.
34	lefcha	1.1	.TP
35			.B -q
36			Be quite; don't print any information at all.
37			.TP
38	lefcha	1.3	.B -s
39			Show some of the headers (specifically Date, From and Subject) of the deleted
40			messages.
41			.TP
42	lefcha	1.1	.B -t
43			Enables test mode, in which the program works as before, but just doesn't
44			delete any messages on remote mailbox.
45			.TP
46			.B -v
47			Be verbose; print detailed information about the program's actions.
48			.SH CONFIGURATION FILE
49	lefcha	1.3	.PP
50	lefcha	1.1	The configuration file has the following format:
51			.PP
52			Empty lines and lines beginning with '#' are considered comments.
53			.PP
54	lefcha	1.4	Otherwise a line is in the format "KEYWORD = ARGUMENT" for account settings,
55			"FILTER = HEADER" for the filters entries, and "LIMIT = SIZE" for the message
56			limits.
57	lefcha	1.1	.PP
58			The available keywords are:
59			.TP
60			.B SERVER
61			Hostname of the mailserver on which to connect.
62			.TP
63			.B PORT
64			TCP/IP port to connect on to remote server. If not provided the default IMAP
65			protocol port (ie. port 143) will be used.
66			.TP
67			.B USERNAME
68			User's name to be used while logging in to server.
69			.TP
70			.B PASSWORD
71			Password of the user.
72			.TP
73			.B LOGFILE
74			Log file to save filtering information and error messages.
75	lefcha	1.2	.PP
76			Filter entries are:
77	lefcha	1.1	.TP
78			.B DENY
79	lefcha	1.2	Remove all messages that match the defined HEADER.
80			.TP
81			.B ALLOW
82			Override all DENY filters and define exceptions, according to which
83	lefcha	1.4	messages will not be deleted. If no DENY filters where defined, then
84			.B everything
85			is deleted except the ALLOW filters.
86	lefcha	1.2	.PP
87	lefcha	1.1	The HEADER is comprised by FIELD-NAME and FIELD-BODY, with the two seperated
88			with an optional ':' character and
89			.B only
90			one space.
91
92			The FIELD-NAME should be one of FROM, TO, CC, BCC, SUBJECT or a user specified
93			header field-name. The FIELD-BODY is a string. Messages that have a header
94			with the defined FIELD-NAME and contain the FIELD-BODY match the DENY filter
95			and are being deleted. The matching is case-insensitive.
96	lefcha	1.5	.PP
97			Message limits are:
98			.TP
99			.B DENY_LIMIT
100			All messages, except those that match the ALLOW filters, with size in octets
101			(bytes) greater than the supplied, are deleted.
102			.TP
103			.B ALLOW_LIMIT
104			Size limit for messages that match the ALLOW filters, in other words, messages
105			that the DENY_LIMIT cannot filter.
106	lefcha	1.1	.SH CONFIGURATION EXAMPLES
107			See
108			.IR sample.imapfilterrc .
109			.SH FILES
110			.TP
111			.I $HOME/.imapfilterrc
112			Default configuration file.
113	lefcha	1.3	.SH ENVIROMENT
114	lefcha	1.1	.TP
115	lefcha	1.3	.B HOME
116			User's home directory.
117	lefcha	1.1	.SH CONFORMING TO
118			.TP
119			IMAP4rev1:
120			RFC 2060
121			.SH AUTHOR
122	lefcha	1.2	Lefteris Chatzibarbas <lefcha@users.sourceforge.net>