NAME

       imapfilter — mail filter

SYNOPSIS

       imapfilter [-iVv] [-c configfile] [-d debugfile] [-e 'command'] [-l logfile]

DESCRIPTION

       imapfilter  is  a  mail filtering utility.  It connects to remote mail servers using the Internet Message
       Access Protocol (IMAP), sends searching queries to the  server  and  processes  mailboxes  based  on  the
       results.  It can be used to delete, copy, move, flag, etc.  messages residing in mailboxes at the same or
       different mail servers.  The 4rev1 and 4 versions of the IMAP protocol are supported.

       The command line options of imapfilter(1) are as follows:

       -c configfile
               Path to the configuration file.  The default is $HOME/.imapfilter/config.lua.

       -d debugfile
               File that contains debugging information about the full communication with the server, along with
               other inner workings' details.

       -e 'command'
               May  be  used  to  enter  “one  line”  of configuration, while it is also possible to pipe a full
               configuration as a string.  When this options is used, a configuration file will not be loaded.

       -i      Enters interactive mode after executing the configuration file.

       -l logfile
               File that contains logs of error messages produced.

       -V      Displays version and copyright information.

       -v      Enables printing of some brief details of the communication with the server.

ENVIRONMENT

       HOME    User's home directory.

FILES

       $HOME/.imapfilter/config.lua
               Default configuration file.  Because this file may contain sensitive data such as user passwords,
               the recommended permissions are read/write for the user, and not accessible by others.

       $HOME/.imapfilter/certificates
               File where the SSL/TLS certificates are stored.

SEE ALSO

       imapfilter_config(5)

CONFORMING TO

       IMAP4rev1:
               RFC 3501, RFC 3348, RFC 2683, RFC 2595, RFC 2342, RFC 2195, RFC 2177

       IMAP4:  RFC 1730

Debian                                          February 19, 2011                                  IMAPFILTER(1)