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

Contents of /imapfilter/imapfilter.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.20 - (show annotations)
Mon May 26 08:28:19 2003 UTC (20 years, 10 months ago) by lefcha
Branch: MAIN
Changes since 1.19: +1 -1 lines
Changed to w the command for saving passwords file.

1 .Dd March 22, 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 .Sh PASSWORD EDITOR
47 .Nm
48 has the capability to encrypt the accounts' passwords and store them
49 separately at
50 .Pa $HOME/.imapfilter/passwords .
51 These passwords are encrypted with a master password, supplied by
52 the user. The Blowfish block cipher with a 128bit key in CBC mode
53 is used to do the encryption. The master password is entered each
54 time
55 .Nm
56 is run, in order to decrypt the password file and retrieve the
57 actual passwords of the user's IMAP mail accounts.
58 .Pp
59 First of all, while defining accounts in the
60 .Nm
61 configuration file, the user must specify only the username and server
62 in those accounts he/she wishes to encrypt the passwords before storage.
63 Then, one can enter the interactive passwords' editor by using the
64 .Fl p
65 option.
66 .Pp
67 After entering the interactive password editor, a command line prompt
68 is used to manage the passwords. The available commands are:
69 .Bl -tag -width Ds
70 .It Cm c
71 Clears a password from an account. It takes as an argument a
72 number, specifying which account's password should be cleared.
73 .It Cm e
74 Edits an account's password entry. It takes as an argument a
75 number, the account's password to be edited.
76 .It Cm h
77 Prints a brief help message of all commands.
78 .It Cm l
79 Lists all accounts. Specifically a number that describes the
80 account, the hostname of the IMAP mail server, the username
81 and the password (if one is already specified).
82 .It Cm p
83 Changes the master password, used to encrypt all other passwords.
84 .It Cm q
85 Quits the password editor without saving changes.
86 .It Cm w
87 Saves changes.
88 .It Cm x
89 Saves changes and exits the password editor.
90 .El
91 .Sh ENVIRONMENT
92 .Bl -tag -width Ds
93 .It Ev HOME
94 User's home directory.
95 .El
96 .Sh FILES
97 .Bl -tag -width Ds
98 .It Pa $HOME/.imapfilterrc
99 Default configuration file.
100 .It Pa $HOME/.imapfilter/passwords
101 File where the encrypted passwords are stored.
102 .It Pa $HOME/.imapfilter/certificates
103 File where the SSL/TLS certificates are stored.
104 .It Pa $HOME/.imapfilter/lock
105 Lock file containing the PID of
106 .Nm .
107 .El
108 .Sh SEE ALSO
109 .Xr imapfilterrc 5
110 .Sh STANDARDS
111 .Bl -tag -width Ds
112 .It IMAP4rev1:
113 RFC 2060, RFC 2342, RFC 2683
114 .El
115 .Sh AUTHORS
116 .An Lefteris Chatzibarbas Aq lefcha@hellug.gr

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26