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

Contents of /imapfilter/imapfilter.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.21 - (show annotations)
Sun Jul 27 17:36:41 2003 UTC (20 years, 8 months ago) by lefcha
Branch: MAIN
Changes since 1.20: +20 -1 lines
New section about AUTHENTICATION and ENCRYPTION.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26