1 |
.Dd November 24, 2003 |
.Dd February 16, 2004 |
2 |
.Dt IMAPFILTER 1 |
.Dt IMAPFILTER 1 |
3 |
.Os |
.Os |
4 |
.Sh NAME |
.Sh NAME |
13 |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
14 |
.Nm |
.Nm |
15 |
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 |
16 |
Internet Message Access Protocol (IMAP) and processes messages based on |
Internet Message Access Protocol (IMAP) and processes messages based on the |
17 |
the definition of filter rules. It can be used to delete, sort, etc. |
definition of filter rules. It can be used to delete, copy, move, flag, etc. |
18 |
messages residing in multiple mailboxes at different mail servers. |
messages residing in multiple mailboxes at different mail servers. The |
19 |
|
IMAP4rev1 and IMAP4 versions of the protocol are supported. |
20 |
.Pp |
.Pp |
21 |
The options are as follows: |
The options are as follows: |
22 |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
23 |
|
.It Fl D |
24 |
|
Debug mode; creates a temporary file name in |
25 |
|
.Pa /tmp/imapfilter.XXXX , |
26 |
|
where debugging messages about the program's progress are printed. |
27 |
|
.It Fl V |
28 |
|
Displays program's version. |
29 |
.It Fl c Ar configfile |
.It Fl c Ar configfile |
30 |
Configuration file to read settings and filters from. The default is |
Configuration file to read settings and filters from. The default is |
31 |
.Pa $HOME/.imapfilterrc . |
.Pa $HOME/.imapfilterrc . |
32 |
.It Fl d Ar interval |
.It Fl d Ar interval |
33 |
Runs imapfilter at daemon mode and repeatedly polls at the specified interval. |
Runs imapfilter at daemon mode and repeatedly polls at the specified interval. |
|
.It Fl h |
|
|
Prints a summary of program's options. |
|
34 |
.It Fl k |
.It Fl k |
35 |
Kills any other running instances of |
Kills any other running instances of |
36 |
.Nm |
.Nm |
42 |
.It Fl p |
.It Fl p |
43 |
Enters the interactive encrypted passwords editor. |
Enters the interactive encrypted passwords editor. |
44 |
.It Fl q |
.It Fl q |
45 |
Quiet mode; no informational messages at all printed. |
Quiet mode; prints less detailed information about the program's actions. |
46 |
|
Multiple |
47 |
|
.Fl q |
48 |
|
options decrease the verbosity. The minimum is -2. |
49 |
.It Fl v |
.It Fl v |
50 |
Verbose mode; prints detailed information about the program's actions. |
Verbose mode; prints more detailed information about the program's actions. |
51 |
.It Fl V |
Multiple |
52 |
Displays program's version. |
.Fl v |
53 |
|
options increase the verbosity. The maximum is 2. |
54 |
.El |
.El |
55 |
.Pp |
.Pp |
56 |
While running in daemon mode, if the SIGUSR1 signal is send, |
While running in daemon mode, if the SIGUSR1 signal is send, |
120 |
.It Cm x |
.It Cm x |
121 |
Saves changes and exits the password editor. |
Saves changes and exits the password editor. |
122 |
.El |
.El |
123 |
.Sh INTERNAL DETAILS |
.Sh INTERNALS |
124 |
After |
After |
125 |
.Nm |
.Nm |
126 |
reads the configuration file and creates all necessary data structures, it |
reads the configuration file and creates all necessary data structures, it |
151 |
.It Pa $HOME/.imapfilter/lock |
.It Pa $HOME/.imapfilter/lock |
152 |
Lock file containing the PID of |
Lock file containing the PID of |
153 |
.Nm . |
.Nm . |
154 |
|
.It Pa /tmp/imapfilter.XXXX |
155 |
|
Debug file. |
156 |
.El |
.El |
157 |
.Sh SEE ALSO |
.Sh SEE ALSO |
158 |
.Xr imapfilterrc 5 |
.Xr imapfilterrc 5 |