1IMAPFILTER(1)             BSD General Commands Manual            IMAPFILTER(1)
2

NAME

4     imapfilter — mail filter
5

SYNOPSIS

7     imapfilter [-inVv] [-c configfile] [-d debugfile] [-e 'command']
8                [-l logfile] [-p pidfile] [-t truststore]
9

DESCRIPTION

11     imapfilter is a mail filtering utility. It connects to remote mail
12     servers using the Internet Message Access Protocol (IMAP), sends search‐
13     ing queries to the server and processes mailboxes based on the results.
14     It can be used to delete, copy, move, flag, etc. messages residing in
15     mailboxes at the same or different mail servers. The 4rev1 and 4 versions
16     of the IMAP protocol are supported.
17
18     The command line options of imapfilter(1) are as follows:
19
20     -c configfile
21             Path to the configuration file to read, or the ‘-’ character to
22             read the configuration from the standard input stream.  The de‐
23             fault is $HOME/.imapfilter/config.lua.
24
25     -d debugfile
26             File that contains debugging information about the full communi‐
27             cation with the server, along with other inner workings' details.
28
29     -e 'command'
30             May be used to enter “one line” of configuration, while it is
31             also possible to pipe a full configuration as a string.  When
32             this option is used, a configuration file will not be loaded.
33
34     -i      Enters interactive mode after executing the configuration file.
35
36     -l logfile
37             File that contains logs of error messages produced.
38
39     -n      This option enables the so called dry-run mode, and any actions
40             that would result in changes to the server do not actually take
41             place. So the requests that would modify any data are not sent to
42             the server, even though informational messages about these ac‐
43             tions are still printed.
44
45             Any other methods, that only receive data from the server, are
46             performed as normal, such as for example the searching methods.
47             Note, that the number of messages an action is reported to be ap‐
48             plied upon, might differ between dry-run mode and the normal exe‐
49             cution, and this is expected as in the latter case the data on
50             the server are continuously altered by subsequent actions.
51
52     -t truststore
53             The path to the system's SSL CA TrustStore directory or file. SSL
54             connections will be validated using the CA certificates found in
55             this directory or file, and when this is not possible, the local
56             $HOME/.imapfilter/certificates file will be used.  The default CA
57             directory is /etc/ssl/certs/, and the default CA file is
58             /etc/ssl/cert.pem.
59
60     -p pidfile
61             Write the process ID (PID) to this file on startup, and delete it
62             on exit.
63
64     -V      Displays version and copyright information.
65
66     -v      Enables printing of some brief details of the communication with
67             the server.
68

ENVIRONMENT

70     HOME    User's home directory.
71
72     IMAPFILTER_HOME
73             Program's configuration directory, which overrides the default
74             $HOME/.imapfilter/.
75

FILES

77     $HOME/.imapfilter/config.lua
78             Default configuration file. Because this file may contain sensi‐
79             tive data such as user passwords, the recommended permissions are
80             read/write for the user, and not accessible by others.
81
82     $HOME/.imapfilter/certificates
83             File where the SSL certificates are stored.
84

SEE ALSO

86     imapfilter_config(5)
87

CONFORMING TO

89     IMAP4rev1:
90             RFC 3501, RFC 3348, RFC 2683, RFC 2595, RFC 2342, RFC 2195, RFC
91             2177
92
93     IMAP4:  RFC 1730
94
95BSD                               Jan 6, 2023                              BSD
Impressum