Configuration Directives for the Mithril IMAP Proxy
The IMAP Proxy configuration file is typically
/etc/mithril/imapproxy.conf. It is broken into the following sections:
Proxy
proxy tag
This key indicates a string which will be prepended to IMAP tags
to indicate that they originated with the proxy. This is useful
for debugging IMAP sessions. Default: "PROXY-"
starttls
This key indicates whether or not the STARTTLS IMAP capability
should be advertised and supported. A value of zero indicates
that it should not, a non-zero value indicates that it should.
Default: 0
TLS cert
This key specifies the file in which the certificate for
TLS negotiation can be found. Default: none
TLS key
This key specifies the file in which the private key for TLS
negotiation can be found. The key MUST NOT be encrypted. If
no key file is specified, the cert file will be used.
Default: none
login disabled
This key indicates that the IMAP server should advertise the
"LOGINDISABLED" capability and refuse the clear-text LOGIN
command unless an encryption layer is in effect. A value of
1 indicates that clear text logins should be disabled, 0
that they should be allowed. Default: 0
chroot dir
This key indicates a directory into which the IMAP proxy
should chroot when handling a session. Default: do not chroot
username
This key indicates the user id to which the IMAP proxy should
change when handling a session. Default: do not change user
cache size
This key indicates the size in kilobytes of the memory cache
for an individual IMAP session. Default: 4096
size cache dir
This key specifies a directory (relative to any chroot) in
which the IMAP proxy may write persistent size information
for messages; this increases performance for clients which
poll the size of all messages upon opening a mailbox.
Default: do not use size cache directory
Server
address
The address key indicates an INET address which should be used
as the "backend" of the proxy. The address may contain an
optional port, such as "localhost:10143"; if no port is given,
the standard IMAP port (143) is assumed. Default: none
path
The path key indicates a file which should be executed
as the "backend" of the proxy. The executed file should
expect to communicate with the proxy using stdin/stdout.
Note: if both path and address are defined, the path key
will be used. Default: none
Fix-up
Keys in this section are described in the fix-up section of this manual.