imapfilter/imapfilter/imapfilter.1

.TH IMAPFILTER 1 "11 August 2001" "Version 0.1" 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
and "FILTER = HEADER" for the filters entries.
.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.
.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.
.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.2	.TH IMAPFILTER 1 "11 August 2001" "Version 0.1" 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			Otherwise a line is in the format "KEYWORD = ARGUMENT" for account settings
55	lefcha	1.2	and "FILTER = HEADER" for the filters entries.
56	lefcha	1.1	.PP
57			The available keywords are:
58			.TP
59			.B SERVER
60			Hostname of the mailserver on which to connect.
61			.TP
62			.B PORT
63			TCP/IP port to connect on to remote server. If not provided the default IMAP
64			protocol port (ie. port 143) will be used.
65			.TP
66			.B USERNAME
67			User's name to be used while logging in to server.
68			.TP
69			.B PASSWORD
70			Password of the user.
71			.TP
72			.B LOGFILE
73			Log file to save filtering information and error messages.
74	lefcha	1.2	.PP
75			Filter entries are:
76	lefcha	1.1	.TP
77			.B DENY
78	lefcha	1.2	Remove all messages that match the defined HEADER.
79			.TP
80			.B ALLOW
81			Override all DENY filters and define exceptions, according to which
82			messages will not be deleted.
83			.PP
84	lefcha	1.1	The HEADER is comprised by FIELD-NAME and FIELD-BODY, with the two seperated
85			with an optional ':' character and
86			.B only
87			one space.
88
89			The FIELD-NAME should be one of FROM, TO, CC, BCC, SUBJECT or a user specified
90			header field-name. The FIELD-BODY is a string. Messages that have a header
91			with the defined FIELD-NAME and contain the FIELD-BODY match the DENY filter
92			and are being deleted. The matching is case-insensitive.
93			.SH CONFIGURATION EXAMPLES
94			See
95			.IR sample.imapfilterrc .
96			.SH FILES
97			.TP
98			.I $HOME/.imapfilterrc
99			Default configuration file.
100	lefcha	1.3	.SH ENVIROMENT
101	lefcha	1.1	.TP
102	lefcha	1.3	.B HOME
103			User's home directory.
104	lefcha	1.1	.SH CONFORMING TO
105			.TP
106			IMAP4rev1:
107			RFC 2060
108			.SH AUTHOR
109	lefcha	1.2	Lefteris Chatzibarbas <lefcha@users.sourceforge.net>