imapfilter |
[-iVv] [-c
configfile] [-d
debugfile] [-e
'command'] [-l
logfile] [-t
truststore] |
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 to read, or the ‘-’ character
to read the configuration from the standard input stream. 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.
-t
truststore
- The path to the system's SSL CA TrustStore directory or file. SSL
connections will be validated using the CA certificates found in this
directory or file, and when this is not possible the local
$HOME/.imapfilter/certificates file will be used.
The default is either the /etc/ssl/certs directory
or the /etc/ssl/cert.pem file, whichever is
found.
-V
- Displays version and copyright information.
-v
- Enables printing of some brief details of the communication with the
server.
HOME
- User's home directory.
IMAPFILTER_HOME
- Program's configuration directory, which overrides the default
$HOME/.imapfilter/.
- $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 certificates are stored.
- IMAP4rev1:
- RFC 3501, RFC 3348, RFC 2683, RFC 2595, RFC 2342, RFC 2195, RFC 2177
- IMAP4:
- RFC 1730