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

Diff of /imapfilter/imapfilter.1

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

revision 1.23 by lefcha, Wed Aug 6 15:07:34 2003 UTC revision 1.24 by lefcha, Sun Nov 23 23:21:59 2003 UTC
# Line 1  Line 1 
1  .Dd August 6, 2003  .Dd November 24, 2003
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
17  the definition of filter rules.  It can be used to delete, sort, etc.  the definition of filter rules.  It can be used to delete, sort, etc.
18  messages residing in multiple mailboxes at different mail servers.  messages residing in multiple mailboxes at different mail servers.
# Line 20  messages residing in multiple mailboxes Line 20  messages residing in multiple mailboxes
20  The options are as follows:  The options are as follows:
21  .Bl -tag -width Ds  .Bl -tag -width Ds
22  .It Fl c Ar configfile  .It Fl c Ar configfile
23  Configuration file to read settings and filters from. The default is  Configuration file to read settings and filters from.  The default is
24  .Pa $HOME/.imapfilterrc .  .Pa $HOME/.imapfilterrc .
25  .It Fl d Ar interval  .It Fl d Ar interval
26  Runs imapfilter at daemon mode and repeatedly polls at the specified interval.  Runs imapfilter at daemon mode and repeatedly polls at the specified interval.
# Line 62  and will try to negotiate a TLS connecti Line 62  and will try to negotiate a TLS connecti
62  .Pp  .Pp
63  .Nm  .Nm
64  supports imaps (port 993) SSL/TLS connections.  The user must manually enable  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  imaps SSL/TLS connections and specify the SSL/TLS protocol to be negotiated,
66  negotiated, through  through
67  .Nm Ap s  .Nm Ap s
68  configuration file.  configuration file.
69  .Sh PASSWORD EDITOR  .Sh PASSWORD EDITOR
# Line 72  has the capability to encrypt the accoun Line 72  has the capability to encrypt the accoun
72  separately at  separately at
73  .Pa $HOME/.imapfilter/passwords .  .Pa $HOME/.imapfilter/passwords .
74  These passwords are encrypted with a master password, supplied by  These passwords are encrypted with a master password, supplied by
75  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
76  is used to do the encryption. The master password is entered each  is used to do the encryption.  The master password is entered each
77  time  time
78  .Nm  .Nm
79  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 88  Then, one can enter the interactive pass Line 88  Then, one can enter the interactive pass
88  option.  option.
89  .Pp  .Pp
90  After entering the interactive password editor, a command line prompt  After entering the interactive password editor, a command line prompt
91  is used to manage the passwords. The available commands are:  is used to manage the passwords.  The available commands are:
92  .Bl -tag -width Ds  .Bl -tag -width Ds
93  .It Cm c  .It Cm c
94  Clears a password from an account. It takes as an argument a  Clears a password from an account.  It takes as an argument a
95  number, specifying which account's password should be cleared.  number, specifying which account's password should be cleared.
96  .It Cm e  .It Cm e
97  Edits an account's password entry. It takes as an argument a  Edits an account's password entry.  It takes as an argument a
98  number, the account's password to be edited.  number, the account's password to be edited.
99  .It Cm h  .It Cm h
100  Prints a brief help message of all commands.  Prints a brief help message of all commands.
101  .It Cm l  .It Cm l
102  Lists all accounts. Specifically a number that describes the  Lists all accounts.  Specifically a number that describes the
103  account, the hostname of the IMAP mail server, the username  account, the hostname of the IMAP mail server, the username
104  and the password (if one is already specified).  and the password (if one is already specified).
105  .It Cm p  .It Cm p
# Line 111  Saves changes. Line 111  Saves changes.
111  .It Cm x  .It Cm x
112  Saves changes and exits the password editor.  Saves changes and exits the password editor.
113  .El  .El
114    .Sh INTERNAL DETAILS
115    After
116    .Nm
117    reads the configuration file and creates all necessary data structures, it
118    starts by going through the list of accounts.  It connects to the servers
119    specified, in the order they were defined in the configuration file with
120    the
121    .Ar account
122    keyword.  It then goes through the list of mailboxes belonging to the server,
123    in the order they were defined in the configuration file with the
124    .Ar folder
125    keyword.  For each mailbox it applies the filters that were specified for it,
126    in the order they were defined in the configuration file using the
127    .Ar job
128    keyword.  This process continues until the last account, mailbox and filter.
129  .Sh ENVIRONMENT  .Sh ENVIRONMENT
130  .Bl -tag -width Ds  .Bl -tag -width Ds
131  .It Ev HOME  .It Ev HOME
Legend:
Removed from v.1.23  
changed lines
  Added in v.1.24
webmaster@linux.gr
 ViewVC Help
Powered by ViewVC 1.1.26