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

Annotation of /imapfilter/imapfilter.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.8 - (hide 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 lefcha 1.6 .TH IMAPFILTER 1 "26 August 2001" "CVS" Commands
2 lefcha 1.1 .SH NAME
3     imapfilter - mail filter
4     .SH SYNOPSIS
5     .B imapfilter
6 lefcha 1.7 .RB [ -hqtv ]
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 lefcha 1.8 defined filter rules. It is purposed as a pre-connect utility before user
16 lefcha 1.1 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.7 produces and optionally information about the deleted messages.
32 lefcha 1.1 .TP
33     .B -q
34 lefcha 1.8 Quite mode; no informational messages at all printed.
35 lefcha 1.1 .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 lefcha 1.8 Verbose mode; prints detailed information about the program's actions.
42 lefcha 1.1 .SH CONFIGURATION FILE
43 lefcha 1.3 .PP
44 lefcha 1.1 The configuration file has the following format:
45     .PP
46     Empty lines and lines beginning with '#' are considered comments.
47     .PP
48 lefcha 1.4 Otherwise a line is in the format "KEYWORD = ARGUMENT" for account settings,
49 lefcha 1.7 "FILTER = HEADER" for the filter entries, "LIMIT = SIZE" for the message
50 lefcha 1.6 limits and "OPTION = ARGUMENT" for any other settings.
51 lefcha 1.1 .PP
52 lefcha 1.6 The available keywords for account settings are:
53 lefcha 1.1 .TP
54     .B SERVER
55 lefcha 1.8 Hostname of the mail server on which to connect.
56 lefcha 1.1 .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 lefcha 1.6 .PP
67 lefcha 1.7 More than one accounts can be declared. The SERVER keyword is used to separate
68 lefcha 1.6 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 lefcha 1.2 .PP
72     Filter entries are:
73 lefcha 1.1 .TP
74     .B DENY
75 lefcha 1.8 Removes all messages that match the defined HEADER.
76 lefcha 1.2 .TP
77     .B ALLOW
78 lefcha 1.8 Overrides all DENY filters and defines exceptions, according to which
79 lefcha 1.4 messages will not be deleted. If no DENY filters where defined, then
80     .B everything
81     is deleted except the ALLOW filters.
82 lefcha 1.2 .PP
83 lefcha 1.8 The HEADER is comprised by FIELD-NAME and FIELD-BODY, with the two separated
84 lefcha 1.1 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 lefcha 1.5 .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 lefcha 1.8 (bytes) greater than the supplied, are deleted.
98 lefcha 1.5 .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 lefcha 1.6 .PP
103 lefcha 1.7 Other optional settings are:
104 lefcha 1.6 .TP
105     .B LOGFILE
106 lefcha 1.7 Log file to save filtering information and error messages. The
107     .B -l
108 lefcha 1.8 option specified at command line overrides this setting.
109 lefcha 1.7 .TP
110     .B SHOW_HEADERS
111 lefcha 1.8 Shows some of the headers (specifically Date, From and Subject) of the deleted
112 lefcha 1.7 messages. The argument must be "yes" or "no". The default is "no".
113     .TP
114     .B TEST_MODE
115 lefcha 1.8 Works as normal, but deleting of messages is skipped. The option
116 lefcha 1.7 .B -t
117 lefcha 1.8 supplied at the command line overrides this setting. The argument must be "yes" or "no". The
118 lefcha 1.7 default is "no".
119     .TP
120     .B UNSEEN_ONLY
121 lefcha 1.8 Applies filters and size limits only to unread messages. The argument must be
122 lefcha 1.7 "yes" or "no". The default is "no".
123 lefcha 1.1 .SH CONFIGURATION EXAMPLES
124     See
125     .IR sample.imapfilterrc .
126     .SH FILES
127     .TP
128     .I $HOME/.imapfilterrc
129     Default configuration file.
130 lefcha 1.3 .SH ENVIROMENT
131 lefcha 1.1 .TP
132 lefcha 1.3 .B HOME
133     User's home directory.
134 lefcha 1.1 .SH CONFORMING TO
135     .TP
136     IMAP4rev1:
137     RFC 2060
138     .SH AUTHOR
139 lefcha 1.2 Lefteris Chatzibarbas <lefcha@users.sourceforge.net>

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26