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

Contents of /imapfilter/imapfilter.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (show annotations)
Sat Aug 11 15:54:57 2001 UTC (22 years, 7 months ago) by lefcha
Branch: MAIN
Changes since 1.1: +14 -3 lines
Added ALLOW type filters

1 .TH IMAPFILTER 1 "11 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 -h
26 Print a summary of program's options.
27 .TP
28 .B -l logfile
29 File that contains logs of any mail deletion and error messages that
30 .B imapfilter
31 produces. The default is
32 .IR $HOME/.imapfilter_log .
33 .TP
34 .B -q
35 Be quite; don't print any information at all.
36 .TP
37 .B -t
38 Enables test mode, in which the program works as before, but just doesn't
39 delete any messages on remote mailbox.
40 .TP
41 .B -v
42 Be verbose; print detailed information about the program's actions.
43 .TP
44 .B -L
45 Disable logging of any information to file.
46 .SH CONFIGURATION FILE
47 The configuration file has the following format:
48 .PP
49 Empty lines and lines beginning with '#' are considered comments.
50 .PP
51 Otherwise a line is in the format "KEYWORD = ARGUMENT" for account settings
52 and "FILTER = HEADER" for the filters entries.
53 .PP
54 The available keywords are:
55 .TP
56 .B SERVER
57 Hostname of the mailserver on which to connect.
58 .TP
59 .B PORT
60 TCP/IP port to connect on to remote server. If not provided the default IMAP
61 protocol port (ie. port 143) will be used.
62 .TP
63 .B USERNAME
64 User's name to be used while logging in to server.
65 .TP
66 .B PASSWORD
67 Password of the user.
68 .TP
69 .B LOGFILE
70 Log file to save filtering information and error messages.
71 .PP
72 Filter entries are:
73 .TP
74 .B DENY
75 Remove all messages that match the defined HEADER.
76 .TP
77 .B ALLOW
78 Override all DENY filters and define exceptions, according to which
79 messages will not be deleted.
80 .PP
81 The HEADER is comprised by FIELD-NAME and FIELD-BODY, with the two seperated
82 with an optional ':' character and
83 .B only
84 one space.
85
86 The FIELD-NAME should be one of FROM, TO, CC, BCC, SUBJECT or a user specified
87 header field-name. The FIELD-BODY is a string. Messages that have a header
88 with the defined FIELD-NAME and contain the FIELD-BODY match the DENY filter
89 and are being deleted. The matching is case-insensitive.
90 .SH CONFIGURATION EXAMPLES
91 See
92 .IR sample.imapfilterrc .
93 .SH ENVIROMENT
94 .TP
95 .B HOME
96 User's home directory.
97 .SH FILES
98 .TP
99 .I $HOME/.imapfilterrc
100 Default configuration file.
101 .TP
102 .I $HOME/.imapfilter_log
103 Default log file.
104 .SH CONFORMING TO
105 .TP
106 IMAP4rev1:
107 RFC 2060
108 .SH AUTHOR
109 Lefteris Chatzibarbas <lefcha@users.sourceforge.net>

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26