1 |
.TH IMAPFILTER 1 "26 August 2001" "CVS" Commands |
.TH IMAPFILTER 1 "10 September 2001" "CVS" Commands |
2 |
.SH NAME |
.SH NAME |
3 |
imapfilter - mail filter |
imapfilter - mail filter |
4 |
.SH SYNOPSIS |
.SH SYNOPSIS |
5 |
.B imapfilter |
.B imapfilter |
6 |
.RB [ -hqtv ] |
.RB [ -hqv ] |
7 |
.RB [ -c |
.RB [ -c |
8 |
.IR configfile ] |
.IR configfile ] |
9 |
.RB [ -l |
.RB [ -l |
11 |
.SH DESCRIPTION |
.SH DESCRIPTION |
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 processes messages based on |
15 |
defined filter rules. It is purposed as a pre-connect utility before user |
the definition of filter rules. It can be used to delete, sort, etc. |
16 |
accesses his/her mailbox (eg. fetch mail). In that way it "clears" user's |
messages residing in multiple mailboxes at different mail servers. |
|
mailbox from any unwanted messages, without having to download even a single |
|
|
header line of them. |
|
17 |
.SH OPTIONS |
.SH OPTIONS |
18 |
.TP |
.TP |
19 |
.B -c configfile |
.B -c configfile |
31 |
.B -q |
.B -q |
32 |
Quite mode; no informational messages at all printed. |
Quite mode; no informational messages at all printed. |
33 |
.TP |
.TP |
|
.B -t |
|
|
Enables test mode, in which the program works as before, but just doesn't |
|
|
delete any messages on remote mailbox. |
|
|
.TP |
|
34 |
.B -v |
.B -v |
35 |
Verbose mode; prints detailed information about the program's actions. |
Verbose mode; prints detailed information about the program's actions. |
|
.SH CONFIGURATION FILE |
|
|
.PP |
|
|
The configuration file has the following format: |
|
|
.PP |
|
|
Empty lines and lines beginning with '#' are considered comments. |
|
|
.PP |
|
|
Otherwise a line is in the format "KEYWORD = ARGUMENT" for account settings, |
|
|
"FILTER = HEADER" for the filter entries, "LIMIT = SIZE" for the message |
|
|
limits and "OPTION = ARGUMENT" for any other settings. |
|
|
.PP |
|
|
The available keywords for account settings are: |
|
|
.TP |
|
|
.B SERVER |
|
|
Hostname of the mail server on which to connect. |
|
|
.TP |
|
|
.B PORT |
|
|
TCP/IP port to connect on to remote server. If not provided the default IMAP |
|
|
protocol port (ie. port 143) will be used. |
|
|
.TP |
|
|
.B USERNAME |
|
|
User's name to be used while logging in to server. |
|
|
.TP |
|
|
.B PASSWORD |
|
|
Password of the user. |
|
|
.PP |
|
|
More than one accounts can be declared. The SERVER keyword is used to separate |
|
|
the accounts and denote the definition of a new account. Whenever a PORT, |
|
|
USERNAME or PASSWORD keyword is found, it associates with the last preceding |
|
|
SERVER argument. |
|
|
.PP |
|
|
Filter entries are: |
|
|
.TP |
|
|
.B DENY |
|
|
Removes all messages that match the defined HEADER. |
|
|
.TP |
|
|
.B ALLOW |
|
|
Overrides all DENY filters and defines exceptions, according to which |
|
|
messages will not be deleted. If no DENY filters where defined, then |
|
|
.B everything |
|
|
is deleted except the ALLOW filters. |
|
|
.PP |
|
|
The HEADER is comprised by FIELD-NAME and FIELD-BODY, with the two separated |
|
|
with an optional ':' character and |
|
|
.B only |
|
|
one space. |
|
|
|
|
|
The FIELD-NAME should be one of FROM, TO, CC, BCC, SUBJECT or a user specified |
|
|
header field-name. The FIELD-BODY is a string. Messages that have a header |
|
|
with the defined FIELD-NAME and contain the FIELD-BODY match the DENY filter |
|
|
and are being deleted. The matching is case-insensitive. |
|
|
.PP |
|
|
Message limits are: |
|
|
.TP |
|
|
.B DENY_LIMIT |
|
|
All messages, except those that match the ALLOW filters, with size in octets |
|
|
(bytes) greater than the supplied, are deleted. |
|
|
.TP |
|
|
.B ALLOW_LIMIT |
|
|
Size limit for messages that match the ALLOW filters, in other words, messages |
|
|
that the DENY_LIMIT cannot filter. |
|
|
.PP |
|
|
Other optional settings are: |
|
|
.TP |
|
|
.B LOGFILE |
|
|
Log file to save filtering information and error messages. The |
|
|
.B -l |
|
|
option specified at command line overrides this setting. |
|
|
.TP |
|
|
.B SHOW_HEADERS |
|
|
Shows some of the headers (specifically Date, From and Subject) of the deleted |
|
|
messages. The argument must be "yes" or "no". The default is "no". |
|
|
.TP |
|
|
.B TEST_MODE |
|
|
Works as normal, but deleting of messages is skipped. The option |
|
|
.B -t |
|
|
supplied at the command line overrides this setting. The argument must be "yes" or "no". The |
|
|
default is "no". |
|
|
.TP |
|
|
.B UNSEEN_ONLY |
|
|
Applies filters and size limits only to unread messages. The argument must be |
|
|
"yes" or "no". The default is "no". |
|
|
.SH CONFIGURATION EXAMPLES |
|
|
See |
|
|
.IR sample.imapfilterrc . |
|
36 |
.SH FILES |
.SH FILES |
37 |
.TP |
.TP |
38 |
.I $HOME/.imapfilterrc |
.I $HOME/.imapfilterrc |
47 |
RFC 2060 |
RFC 2060 |
48 |
.SH AUTHOR |
.SH AUTHOR |
49 |
Lefteris Chatzibarbas <lefcha@users.sourceforge.net> |
Lefteris Chatzibarbas <lefcha@users.sourceforge.net> |
50 |
|
.SH SEE ALSO |
51 |
|
imapfilterrc(5), imapfilterex(5) |