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

Diff of /imapfilter/imapfilter.1

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.7 by lefcha, Sun Aug 26 20:00:09 2001 UTC revision 1.8 by lefcha, Sun Aug 26 21:10:43 2001 UTC
# Line 12  imapfilter - mail filter Line 12  imapfilter - mail filter
12  .B imapfilter  .B imapfilter
13  is a mail filtering utility. It connects to remote mail servers using the  is a mail filtering utility. It connects to remote mail servers using the
14  Internet Message Access Protocol (IMAP) and deletes messages according to  Internet Message Access Protocol (IMAP) and deletes messages according to
15  defined filter rules. It is purposed as a preconnect utility before user  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  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  mailbox from any unwanted messages, without having to download even a single
18  header line of them.  header line of them.
# Line 31  File that contains logs of error message Line 31  File that contains logs of error message
31  produces and optionally information about the deleted messages.  produces and optionally information about the deleted messages.
32  .TP  .TP
33  .B -q  .B -q
34  Be quite; don't print any information at all.  Quite mode; no informational messages at all printed.
35  .TP  .TP
36  .B -t  .B -t
37  Enables test mode, in which the program works as before, but just doesn't  Enables test mode, in which the program works as before, but just doesn't
38  delete any messages on remote mailbox.  delete any messages on remote mailbox.
39  .TP  .TP
40  .B -v  .B -v
41  Be verbose; print detailed information about the program's actions.  Verbose mode; prints detailed information about the program's actions.
42  .SH CONFIGURATION FILE  .SH CONFIGURATION FILE
43  .PP  .PP
44  The configuration file has the following format:  The configuration file has the following format:
# Line 52  limits and "OPTION = ARGUMENT" for any o Line 52  limits and "OPTION = ARGUMENT" for any o
52  The available keywords for account settings are:  The available keywords for account settings are:
53  .TP  .TP
54  .B SERVER  .B SERVER
55  Hostname of the mailserver on which to connect.  Hostname of the mail server on which to connect.
56  .TP  .TP
57  .B PORT  .B PORT
58  TCP/IP port to connect on to remote server. If not provided the default IMAP  TCP/IP port to connect on to remote server. If not provided the default IMAP
# Line 72  SERVER argument. Line 72  SERVER argument.
72  Filter entries are:  Filter entries are:
73  .TP  .TP
74  .B DENY  .B DENY
75  Remove all messages that match the defined HEADER.  Removes all messages that match the defined HEADER.
76  .TP  .TP
77  .B ALLOW  .B ALLOW
78  Override all DENY filters and define exceptions, according to which  Overrides all DENY filters and defines exceptions, according to which
79  messages will not be deleted.  If no DENY filters where defined, then  messages will not be deleted.  If no DENY filters where defined, then
80  .B everything  .B everything
81  is deleted except the ALLOW filters.  is deleted except the ALLOW filters.
82  .PP  .PP
83  The HEADER is comprised by FIELD-NAME and FIELD-BODY, with the two seperated  The HEADER is comprised by FIELD-NAME and FIELD-BODY, with the two separated
84  with an optional ':' character and  with an optional ':' character and
85  .B only  .B only
86  one space.  one space.
# Line 94  Message limits are: Line 94  Message limits are:
94  .TP  .TP
95  .B DENY_LIMIT  .B DENY_LIMIT
96  All messages, except those that match the ALLOW filters, with size in octets  All messages, except those that match the ALLOW filters, with size in octets
97  q(bytes) greater than the supplied, are deleted.  (bytes) greater than the supplied, are deleted.
98  .TP  .TP
99  .B ALLOW_LIMIT  .B ALLOW_LIMIT
100  Size limit for messages that match the ALLOW filters, in other words, messages  Size limit for messages that match the ALLOW filters, in other words, messages
# Line 105  Other optional settings are: Line 105  Other optional settings are:
105  .B LOGFILE  .B LOGFILE
106  Log file to save filtering information and error messages. The  Log file to save filtering information and error messages. The
107  .B -l  .B -l
108  option from command line overrides this setting.  option specified at command line overrides this setting.
109  .TP  .TP
110  .B SHOW_HEADERS  .B SHOW_HEADERS
111  Show some of the headers (specifically Date, From and Subject) of the deleted  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".  messages. The argument must be "yes" or "no". The default is "no".
113  .TP  .TP
114  .B TEST_MODE  .B TEST_MODE
115  Just don't delete any messages. The option  Works as normal, but deleting of messages is skipped. The option
116  .B -t  .B -t
117  supplied in the command line overides this setting.  The argument must be "yes" or "no". The  supplied at the command line overrides this setting.  The argument must be "yes" or "no". The
118  default is "no".  default is "no".
119  .TP  .TP
120  .B UNSEEN_ONLY  .B UNSEEN_ONLY
121  Apply filters and size limits only to unread messages. The argument must be  Applies filters and size limits only to unread messages. The argument must be
122  "yes" or "no". The default is "no".  "yes" or "no". The default is "no".
123  .SH CONFIGURATION EXAMPLES  .SH CONFIGURATION EXAMPLES
124  See  See

Legend:
Removed from v.1.7  
changed lines
  Added in v.1.8

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26