/[imapfilter]/imapfilter/imapfilter.1
ViewVC logotype

Contents of /imapfilter/imapfilter.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.4 - (show annotations)
Mon Aug 20 21:40:57 2001 UTC (22 years, 7 months ago) by lefcha
Branch: MAIN
Changes since 1.3: +15 -4 lines
Added message size limits support

1 .TH IMAPFILTER 1 "21 August 2001" "Version 0.2" Commands
2 .SH NAME
3 imapfilter - mail filter
4 .SH SYNOPSIS
5 .B imapfilter
6 .RB [ -hqstv ]
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 -h
26 Prints a summary of program's options.
27 .TP
28 .B -l logfile
29 File that contains logs of error messages
30 .B imapfilter
31 produces and optionally, if the
32 .B -s
33 option is given, information about the deleted messages.
34 .TP
35 .B -q
36 Be quite; don't print any information at all.
37 .TP
38 .B -s
39 Show some of the headers (specifically Date, From and Subject) of the deleted
40 messages.
41 .TP
42 .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 .PP
50 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 "FILTER = HEADER" for the filters entries, and "LIMIT = SIZE" for the message
56 limits.
57 .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 .PP
76 Filter entries are:
77 .TP
78 .B DENY
79 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 messages will not be deleted. If no DENY filters where defined, then
84 .B everything
85 is deleted except the ALLOW filters.
86 .TP
87 .B DENY_LIMIT
88 All messages, except those that match the ALLOW filters, with size in octets
89 (bytes) greater than the supplied, are deleted.
90 .TP
91 .B ALLOW_LIMIT
92 Size limit for messages that match the ALLOW filters, in other words, messages
93 that the DENY_LIMIT cannot filter.
94 .PP
95 The HEADER is comprised by FIELD-NAME and FIELD-BODY, with the two seperated
96 with an optional ':' character and
97 .B only
98 one space.
99
100 The FIELD-NAME should be one of FROM, TO, CC, BCC, SUBJECT or a user specified
101 header field-name. The FIELD-BODY is a string. Messages that have a header
102 with the defined FIELD-NAME and contain the FIELD-BODY match the DENY filter
103 and are being deleted. The matching is case-insensitive.
104 .SH CONFIGURATION EXAMPLES
105 See
106 .IR sample.imapfilterrc .
107 .SH FILES
108 .TP
109 .I $HOME/.imapfilterrc
110 Default configuration file.
111 .SH ENVIROMENT
112 .TP
113 .B HOME
114 User's home directory.
115 .SH CONFORMING TO
116 .TP
117 IMAP4rev1:
118 RFC 2060
119 .SH AUTHOR
120 Lefteris Chatzibarbas <lefcha@users.sourceforge.net>

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26