IMAPFILTER(1)

NAME
imapfilter - mail filter

SYNOPSIS
imapfilter [-hkpqv] [-c configfile] [-d interval] [-l logfile]

DESCRIPTION
imapfilter is a mail filtering utility. It connects to remote mail servers using the Internet Message Access Protocol (IMAP) and processes messages based on the definition of filter rules. It can be used to delete, sort, etc. messages residing in multiple mailboxes at different mail servers.

The options are as follows:

-c configfile
    Configuration file to read settings and filters from. The default is $HOME/.imapfilterrc.

-d interval
    Runs imapfilter at daemon mode and repeatedly polls at the specified interval.

-h  Prints a summary of program's options.

-k  Kills any other running instances of imapfilter and removes the lockfile left from a past session.

-l logfile
    File that contains logs of error messages imapfilter produces and optionally information about the deleted messages.

-p  Enters the interactive encrypted passwords editor.

-q  Quiet mode; no informational messages at all printed.

-v  Verbose mode; prints detailed information about the program's actions.

-V  Displays program's version.

PASSWORD EDITOR
imapfilter has the capability to encrypt the accounts' passwords and store them separately at $HOME/.imapfilter/passwords. These passwords are encrypted with a master password, supplied by the user. The Blowfish block cipher with a 128bit key in CBC mode is used to do the encryption. The master password is entered each time imapfilter is run, in order to decrypt the password file and retrieve the actual passwords of the user's IMAP mail accounts.

First of all, while defining accounts in the imapfilter configuration file, the user must specify only the username and server in those accounts he/she wishes to encrypt the passwords before storage. Then, one can enter the interactive passwords' editor by using the -p option.

After entering the interactive password editor, a command line prompt is used to manage the passwords. The available commands are:

c   Clears a password from an account. It takes as an argument a number, specifying which account's password should be cleared.

e   Edits an account's password entry. It takes as an argument a number, the account's password to be edited.

h   Prints a brief help message of all commands.

l   Lists all accounts. Specifically a number that describes the account, the hostname of the IMAP mail server, the username and the password (if one is already specified).

p   Changes the master password, used to encrypt all other passwords.

q   Quits the password editor without saving changes.

s   Saves changes.

x   Saves changes and exits the password editor.

ENVIROMENT

HOME
    User's home directory.

FILES

$HOME/.imapfilterrc
    Default configuration file.

$HOME/.imapfilter/passwords
    File where the encrypted passwords are stored.

$HOME/.imapfilter/lock
    Lock file containing the PID of imapfilter.

SEE ALSO
imapfilterrc(5)

STANDARDS

IMAP4rev1:
    RFC 2060

AUTHORS
Lefteris Chatzibarbas <lefcha@hellug.gr>