1 |
.Dd August 6, 2003 |
2 |
.Dt IMAPFILTER 1 |
3 |
.Os |
4 |
.Sh NAME |
5 |
.Nm imapfilter |
6 |
.Nd mail filter |
7 |
.Sh SYNOPSIS |
8 |
.Nm |
9 |
.Op Fl hkpqvV |
10 |
.Op Fl c Ar configfile |
11 |
.Op Fl d Ar interval |
12 |
.Op Fl l Ar logfile |
13 |
.Sh DESCRIPTION |
14 |
.Nm |
15 |
is a mail filtering utility. It connects to remote mail servers using the |
16 |
Internet Message Access Protocol (IMAP) and processes messages based on |
17 |
the definition of filter rules. It can be used to delete, sort, etc. |
18 |
messages residing in multiple mailboxes at different mail servers. |
19 |
.Pp |
20 |
The options are as follows: |
21 |
.Bl -tag -width Ds |
22 |
.It Fl c Ar configfile |
23 |
Configuration file to read settings and filters from. The default is |
24 |
.Pa $HOME/.imapfilterrc . |
25 |
.It Fl d Ar interval |
26 |
Runs imapfilter at daemon mode and repeatedly polls at the specified interval. |
27 |
.It Fl h |
28 |
Prints a summary of program's options. |
29 |
.It Fl k |
30 |
Kills any other running instances of |
31 |
.Nm |
32 |
and removes the lockfile left from a past session. |
33 |
.It Fl l Ar logfile |
34 |
File that contains logs of error messages |
35 |
.Nm |
36 |
produces and optionally information about the deleted messages. |
37 |
.It Fl p |
38 |
Enters the interactive encrypted passwords editor. |
39 |
.It Fl q |
40 |
Quiet mode; no informational messages at all printed. |
41 |
.It Fl v |
42 |
Verbose mode; prints detailed information about the program's actions. |
43 |
.It Fl V |
44 |
Displays program's version. |
45 |
.El |
46 |
.Pp |
47 |
While running in daemon mode, if the SIGUSR1 signal is send, |
48 |
.Nm |
49 |
wakes up from its sleep phase and rereads its configuration file. |
50 |
.Sh AUTHENTICATION AND ENCRYPTION |
51 |
.Nm |
52 |
supports the Challenge-Response Authentication Mechanism (CRAM) for |
53 |
user authentication. The authentication type associated with CRAM is |
54 |
CRAM-MD5. |
55 |
.Nm |
56 |
will authenticate using CRAM-MD5, if the mail server supports this |
57 |
authentication method, instead of plaintext password LOGIN. |
58 |
.Pp |
59 |
.Nm |
60 |
supports encryption of the connection with the IMAP STARTTLS extension, |
61 |
and will try to negotiate a TLS connection if the mail server supports it. |
62 |
.Pp |
63 |
.Nm |
64 |
supports imaps (port 993) SSL/TLS connections. The user must manually enable |
65 |
imaps SSL/TLS connections and optionally specify the SSL/TLS protocol to be |
66 |
negotiated, through |
67 |
.Nm Ap s |
68 |
configuration file. |
69 |
.Sh PASSWORD EDITOR |
70 |
.Nm |
71 |
has the capability to encrypt the accounts' passwords and store them |
72 |
separately at |
73 |
.Pa $HOME/.imapfilter/passwords . |
74 |
These passwords are encrypted with a master password, supplied by |
75 |
the user. The Blowfish block cipher with a 128bit key in CBC mode |
76 |
is used to do the encryption. The master password is entered each |
77 |
time |
78 |
.Nm |
79 |
is run, in order to decrypt the password file and retrieve the |
80 |
actual passwords of the user's IMAP mail accounts. |
81 |
.Pp |
82 |
First of all, while defining accounts in the |
83 |
.Nm |
84 |
configuration file, the user must specify only the username and server |
85 |
in those accounts he/she wishes to encrypt the passwords before storage. |
86 |
Then, one can enter the interactive passwords' editor by using the |
87 |
.Fl p |
88 |
option. |
89 |
.Pp |
90 |
After entering the interactive password editor, a command line prompt |
91 |
is used to manage the passwords. The available commands are: |
92 |
.Bl -tag -width Ds |
93 |
.It Cm c |
94 |
Clears a password from an account. It takes as an argument a |
95 |
number, specifying which account's password should be cleared. |
96 |
.It Cm e |
97 |
Edits an account's password entry. It takes as an argument a |
98 |
number, the account's password to be edited. |
99 |
.It Cm h |
100 |
Prints a brief help message of all commands. |
101 |
.It Cm l |
102 |
Lists all accounts. Specifically a number that describes the |
103 |
account, the hostname of the IMAP mail server, the username |
104 |
and the password (if one is already specified). |
105 |
.It Cm p |
106 |
Changes the master password, used to encrypt all other passwords. |
107 |
.It Cm q |
108 |
Quits the password editor without saving changes. |
109 |
.It Cm w |
110 |
Saves changes. |
111 |
.It Cm x |
112 |
Saves changes and exits the password editor. |
113 |
.El |
114 |
.Sh ENVIRONMENT |
115 |
.Bl -tag -width Ds |
116 |
.It Ev HOME |
117 |
User's home directory. |
118 |
.El |
119 |
.Sh FILES |
120 |
.Bl -tag -width Ds |
121 |
.It Pa $HOME/.imapfilterrc |
122 |
Default configuration file. |
123 |
.It Pa $HOME/.imapfilter/passwords |
124 |
File where the encrypted passwords are stored. |
125 |
.It Pa $HOME/.imapfilter/certificates |
126 |
File where the SSL/TLS certificates are stored. |
127 |
.It Pa $HOME/.imapfilter/lock |
128 |
Lock file containing the PID of |
129 |
.Nm . |
130 |
.El |
131 |
.Sh SEE ALSO |
132 |
.Xr imapfilterrc 5 |
133 |
.Sh STANDARDS |
134 |
.Bl -tag -width Ds |
135 |
.It IMAP4rev1: |
136 |
RFC 3501, RFC 2683, RFC 2595, RFC 2342, RFC 2195 |
137 |
.El |
138 |
.Sh AUTHORS |
139 |
.An Lefteris Chatzibarbas Aq lefcha@hellug.gr |