3 |
imapfilter - mail filter |
imapfilter - mail filter |
4 |
.SH SYNOPSIS |
.SH SYNOPSIS |
5 |
.B imapfilter |
.B imapfilter |
6 |
.RB [ -hqstv ] |
.RB [ -hqtv ] |
7 |
.RB [ -c |
.RB [ -c |
8 |
.IR configfile ] |
.IR configfile ] |
9 |
.RB [ -l |
.RB [ -l |
28 |
.B -l logfile |
.B -l logfile |
29 |
File that contains logs of error messages |
File that contains logs of error messages |
30 |
.B imapfilter |
.B imapfilter |
31 |
produces and optionally, if the |
produces and optionally information about the deleted messages. |
|
.B -s |
|
|
option is given, information about the deleted messages. |
|
32 |
.TP |
.TP |
33 |
.B -q |
.B -q |
34 |
Be quite; don't print any information at all. |
Be quite; don't print any information at all. |
35 |
.TP |
.TP |
|
.B -s |
|
|
Show some of the headers (specifically Date, From and Subject) of the deleted |
|
|
messages. |
|
|
.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. |
46 |
Empty lines and lines beginning with '#' are considered comments. |
Empty lines and lines beginning with '#' are considered comments. |
47 |
.PP |
.PP |
48 |
Otherwise a line is in the format "KEYWORD = ARGUMENT" for account settings, |
Otherwise a line is in the format "KEYWORD = ARGUMENT" for account settings, |
49 |
"FILTER = HEADER" for the filters entries, "LIMIT = SIZE" for the message |
"FILTER = HEADER" for the filter entries, "LIMIT = SIZE" for the message |
50 |
limits and "OPTION = ARGUMENT" for any other settings. |
limits and "OPTION = ARGUMENT" for any other settings. |
51 |
.PP |
.PP |
52 |
The available keywords for account settings are: |
The available keywords for account settings are: |
64 |
.B PASSWORD |
.B PASSWORD |
65 |
Password of the user. |
Password of the user. |
66 |
.PP |
.PP |
67 |
More than one accounts can be declared. The SERVER keyword is used to seperate |
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, |
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 |
USERNAME or PASSWORD keyword is found, it associates with the last preceding |
70 |
SERVER argument. |
SERVER argument. |
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 |
(bytes) greater than the supplied, are deleted. |
q(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 |
101 |
that the DENY_LIMIT cannot filter. |
that the DENY_LIMIT cannot filter. |
102 |
.PP |
.PP |
103 |
Other options are: |
Other optional settings are: |
104 |
.TP |
.TP |
105 |
.B LOGFILE |
.B LOGFILE |
106 |
Log file to save filtering information and error messages. |
Log file to save filtering information and error messages. The |
107 |
|
.B -l |
108 |
|
option from command line overrides this setting. |
109 |
|
.TP |
110 |
|
.B SHOW_HEADERS |
111 |
|
Show 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 |
|
Just don't delete any messages. The option |
116 |
|
.B -t |
117 |
|
supplied in the command line overides this setting. The argument must be "yes" or "no". The |
118 |
|
default is "no". |
119 |
|
.TP |
120 |
|
.B UNSEEN_ONLY |
121 |
|
Apply filters and size limits only to unread messages. The argument must be |
122 |
|
"yes" or "no". The default is "no". |
123 |
.SH CONFIGURATION EXAMPLES |
.SH CONFIGURATION EXAMPLES |
124 |
See |
See |
125 |
.IR sample.imapfilterrc . |
.IR sample.imapfilterrc . |