2012-02-19 07:25:47 -05:00
|
|
|
.Dd February 19, 2011
|
2011-03-06 06:58:58 -05:00
|
|
|
.Dt IMAPFILTER 1
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm imapfilter
|
|
|
|
|
.Nd mail filter
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.Nm
|
2012-02-19 07:25:47 -05:00
|
|
|
.Op Fl iVv
|
2011-03-06 06:58:58 -05:00
|
|
|
.Op Fl c Ar configfile
|
2012-02-19 07:25:47 -05:00
|
|
|
.Op Fl d Ar debugfile
|
2011-03-06 06:58:58 -05:00
|
|
|
.Op Fl e Ar 'command'
|
|
|
|
|
.Op Fl l Ar logfile
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
.Nm
|
|
|
|
|
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.
|
|
|
|
|
.Pp
|
|
|
|
|
The command line options of
|
|
|
|
|
.Xr imapfilter 1
|
|
|
|
|
are as follows:
|
|
|
|
|
.Bl -tag -width Ds
|
|
|
|
|
.It Fl c Ar configfile
|
|
|
|
|
Path to the configuration file. The default is
|
|
|
|
|
.Pa $HOME/.imapfilter/config.lua .
|
2012-02-19 07:25:47 -05:00
|
|
|
.It Fl d Ar debugfile
|
|
|
|
|
File that contains debugging information about the full communication with the
|
|
|
|
|
server, along with other inner workings' details.
|
2011-03-06 06:58:58 -05:00
|
|
|
.It Fl e Ar 'command'
|
2012-02-19 07:25:47 -05:00
|
|
|
May be used to enter
|
|
|
|
|
.Dq 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.
|
2011-03-06 06:58:58 -05:00
|
|
|
.It Fl i
|
2012-02-19 07:25:47 -05:00
|
|
|
Enters interactive mode after executing the configuration file.
|
2011-03-06 06:58:58 -05:00
|
|
|
.It Fl l Ar logfile
|
2012-02-19 07:25:47 -05:00
|
|
|
File that contains logs of error messages produced.
|
2011-04-04 17:39:25 -04:00
|
|
|
.It Fl V
|
2012-02-19 07:25:47 -05:00
|
|
|
Displays version and copyright information.
|
2011-03-06 06:58:58 -05:00
|
|
|
.It Fl v
|
2012-02-19 07:25:47 -05:00
|
|
|
Enables printing of some brief details of the communication with the server.
|
2011-03-06 06:58:58 -05:00
|
|
|
.El
|
|
|
|
|
.Sh ENVIRONMENT
|
|
|
|
|
.Bl -tag -width Ds
|
|
|
|
|
.It Ev HOME
|
|
|
|
|
User's home directory.
|
|
|
|
|
.El
|
|
|
|
|
.Sh FILES
|
|
|
|
|
.Bl -tag -width Ds
|
|
|
|
|
.It Pa $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.
|
|
|
|
|
.It Pa $HOME/.imapfilter/certificates
|
|
|
|
|
File where the SSL/TLS certificates are stored.
|
|
|
|
|
.El
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr imapfilter_config 5
|
|
|
|
|
.Sh CONFORMING TO
|
|
|
|
|
.Bl -tag -width Ds
|
|
|
|
|
.It IMAP4rev1:
|
|
|
|
|
RFC 3501, RFC 3348, RFC 2683, RFC 2595, RFC 2342, RFC 2195,
|
|
|
|
|
RFC 2177
|
|
|
|
|
.It IMAP4:
|
|
|
|
|
RFC 1730
|
|
|
|
|
.El
|
