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

Diff of /imapfilter/imapfilter.1

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.14.2.3 by lefcha, Sun May 25 00:41:15 2003 UTC revision 1.26 by lefcha, Thu Feb 19 11:29:53 2004 UTC
# Line 1  Line 1 
1  .Dd February 02, 2002  .Dd February 16, 2004
2  .Dt IMAPFILTER 1  .Dt IMAPFILTER 1
3  .Os  .Os
4  .Sh NAME  .Sh NAME
# Line 12  Line 12 
12  .Op Fl l Ar logfile  .Op Fl l Ar logfile
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
# Line 37  produces and optionally information abou Line 42  produces and optionally information abou
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
56    While running in daemon mode, if the SIGUSR1 signal is send,
57    .Nm
58    wakes up from its sleep phase and rereads its configuration file.
59    .Sh AUTHENTICATION AND ENCRYPTION
60    .Nm
61    supports the Challenge-Response Authentication Mechanism (CRAM) for
62    user authentication.  The authentication type associated with CRAM is
63    CRAM-MD5.
64    .Nm
65    will authenticate using CRAM-MD5, if the mail server supports this
66    authentication method, instead of plaintext password LOGIN.
67    .Pp
68    .Nm
69    supports encryption of the connection with the IMAP STARTTLS extension,
70    and will try to negotiate a TLS connection if the mail server supports it.
71    .Pp
72    .Nm
73    supports imaps (port 993) SSL/TLS connections.  The user must manually enable
74    imaps SSL/TLS connections and specify the SSL/TLS protocol to be negotiated,
75    through
76    .Nm Ap s
77    configuration file.
78  .Sh PASSWORD EDITOR  .Sh PASSWORD EDITOR
79  .Nm  .Nm
80  has the capability to encrypt the accounts' passwords and store them  has the capability to encrypt the accounts' passwords and store them
81  separately at  separately at
82  .Pa $HOME/.imapfilter/passwords .  .Pa $HOME/.imapfilter/passwords .
83  These passwords are encrypted with a master password, supplied by  These passwords are encrypted with a master password, supplied by
84  the user. The Blowfish block cipher with a 128bit key in CBC mode  the user.  The Blowfish block cipher with a 128bit key in CBC mode
85  is used to do the encryption. The master password is entered each  is used to do the encryption.  The master password is entered each
86  time  time
87  .Nm  .Nm
88  is run, in order to decrypt the password file and retrieve the  is run, in order to decrypt the password file and retrieve the
# Line 65  Then, one can enter the interactive pass Line 97  Then, one can enter the interactive pass
97  option.  option.
98  .Pp  .Pp
99  After entering the interactive password editor, a command line prompt  After entering the interactive password editor, a command line prompt
100  is used to manage the passwords. The available commands are:  is used to manage the passwords.  The available commands are:
101  .Bl -tag -width Ds  .Bl -tag -width Ds
102  .It Cm c  .It Cm c
103  Clears a password from an account. It takes as an argument a  Clears a password from an account.  It takes as an argument a
104  number, specifying which account's password should be cleared.  number, specifying which account's password should be cleared.
105  .It Cm e  .It Cm e
106  Edits an account's password entry. It takes as an argument a  Edits an account's password entry.  It takes as an argument a
107  number, the account's password to be edited.  number, the account's password to be edited.
108  .It Cm h  .It Cm h
109  Prints a brief help message of all commands.  Prints a brief help message of all commands.
110  .It Cm l  .It Cm l
111  Lists all accounts. Specifically a number that describes the  Lists all accounts.  Specifically a number that describes the
112  account, the hostname of the IMAP mail server, the username  account, the hostname of the IMAP mail server, the username
113  and the password (if one is already specified).  and the password (if one is already specified).
114  .It Cm p  .It Cm p
115  Changes the master password, used to encrypt all other passwords.  Changes the master password, used to encrypt all other passwords.
116  .It Cm q  .It Cm q
117  Quits the password editor without saving changes.  Quits the password editor without saving changes.
118  .It Cm s  .It Cm w
119  Saves changes.  Saves changes.
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 INTERNALS
124    After
125    .Nm
126    reads the configuration file and creates all necessary data structures, it
127    starts by going through the list of accounts.  It connects to the servers
128    specified, in the order they were defined in the configuration file with
129    the
130    .Ar account
131    keyword.  It then goes through the list of mailboxes belonging to the server,
132    in the order they were defined in the configuration file with the
133    .Ar folder
134    keyword.  For each mailbox it applies the filters that were specified for it,
135    in the order they were defined in the configuration file using the
136    .Ar job
137    keyword.  This process continues until the last account, mailbox and filter.
138  .Sh ENVIRONMENT  .Sh ENVIRONMENT
139  .Bl -tag -width Ds  .Bl -tag -width Ds
140  .It Ev HOME  .It Ev HOME
# Line 99  User's home directory. Line 146  User's home directory.
146  Default configuration file.  Default configuration file.
147  .It Pa $HOME/.imapfilter/passwords  .It Pa $HOME/.imapfilter/passwords
148  File where the encrypted passwords are stored.  File where the encrypted passwords are stored.
149    .It Pa $HOME/.imapfilter/certificates
150    File where the SSL/TLS certificates are stored.
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
159  .Sh STANDARDS  .Sh STANDARDS
160  .Bl -tag -width Ds  .Bl -tag -width Ds
161  .It IMAP4rev1:  .It IMAP4rev1:
162  RFC 2060, RFC 2342, RFC 2683  RFC 3501, RFC 2683, RFC 2595, RFC 2342, RFC 2195
163  .El  .El
164  .Sh AUTHORS  .Sh AUTHORS
165  .An Lefteris Chatzibarbas Aq lefcha@hellug.gr  .An Lefteris Chatzibarbas Aq lefcha@hellug.gr

Legend:
Removed from v.1.14.2.3  
changed lines
  Added in v.1.26

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26