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

Contents of /imapfilter/imapfilter.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.8 - (show annotations)
Sun Aug 26 21:10:43 2001 UTC (22 years, 7 months ago) by lefcha
Branch: MAIN
Changes since 1.7: +13 -13 lines
Typo errors fixed.

1 .TH IMAPFILTER 1 "26 August 2001" "CVS" Commands
2 .SH NAME
3 imapfilter - mail filter
4 .SH SYNOPSIS
5 .B imapfilter
6 .RB [ -hqtv ]
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 pre-connect 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 information about the deleted messages.
32 .TP
33 .B -q
34 Quite mode; no informational messages at all printed.
35 .TP
36 .B -t
37 Enables test mode, in which the program works as before, but just doesn't
38 delete any messages on remote mailbox.
39 .TP
40 .B -v
41 Verbose mode; prints detailed information about the program's actions.
42 .SH CONFIGURATION FILE
43 .PP
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 "FILTER = HEADER" for the filter entries, "LIMIT = SIZE" for the message
50 limits and "OPTION = ARGUMENT" for any other settings.
51 .PP
52 The available keywords for account settings are:
53 .TP
54 .B SERVER
55 Hostname of the mail server on which to connect.
56 .TP
57 .B PORT
58 TCP/IP port to connect on to remote server. If not provided the default IMAP
59 protocol port (ie. port 143) will be used.
60 .TP
61 .B USERNAME
62 User's name to be used while logging in to server.
63 .TP
64 .B PASSWORD
65 Password of the user.
66 .PP
67 More than one accounts can be declared. The SERVER keyword is used to separate
68 the accounts and denote the definition of a new account. Whenever a PORT,
69 USERNAME or PASSWORD keyword is found, it associates with the last preceding
70 SERVER argument.
71 .PP
72 Filter entries are:
73 .TP
74 .B DENY
75 Removes all messages that match the defined HEADER.
76 .TP
77 .B ALLOW
78 Overrides all DENY filters and defines exceptions, according to which
79 messages will not be deleted. If no DENY filters where defined, then
80 .B everything
81 is deleted except the ALLOW filters.
82 .PP
83 The HEADER is comprised by FIELD-NAME and FIELD-BODY, with the two separated
84 with an optional ':' character and
85 .B only
86 one space.
87
88 The FIELD-NAME should be one of FROM, TO, CC, BCC, SUBJECT or a user specified
89 header field-name. The FIELD-BODY is a string. Messages that have a header
90 with the defined FIELD-NAME and contain the FIELD-BODY match the DENY filter
91 and are being deleted. The matching is case-insensitive.
92 .PP
93 Message limits are:
94 .TP
95 .B DENY_LIMIT
96 All messages, except those that match the ALLOW filters, with size in octets
97 (bytes) greater than the supplied, are deleted.
98 .TP
99 .B ALLOW_LIMIT
100 Size limit for messages that match the ALLOW filters, in other words, messages
101 that the DENY_LIMIT cannot filter.
102 .PP
103 Other optional settings are:
104 .TP
105 .B LOGFILE
106 Log file to save filtering information and error messages. The
107 .B -l
108 option specified at command line overrides this setting.
109 .TP
110 .B SHOW_HEADERS
111 Shows some of the headers (specifically Date, From and Subject) of the deleted
112 messages. The argument must be "yes" or "no". The default is "no".
113 .TP
114 .B TEST_MODE
115 Works as normal, but deleting of messages is skipped. The option
116 .B -t
117 supplied at the command line overrides this setting. The argument must be "yes" or "no". The
118 default is "no".
119 .TP
120 .B UNSEEN_ONLY
121 Applies filters and size limits only to unread messages. The argument must be
122 "yes" or "no". The default is "no".
123 .SH CONFIGURATION EXAMPLES
124 See
125 .IR sample.imapfilterrc .
126 .SH FILES
127 .TP
128 .I $HOME/.imapfilterrc
129 Default configuration file.
130 .SH ENVIROMENT
131 .TP
132 .B HOME
133 User's home directory.
134 .SH CONFORMING TO
135 .TP
136 IMAP4rev1:
137 RFC 2060
138 .SH AUTHOR
139 Lefteris Chatzibarbas <lefcha@users.sourceforge.net>

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26