imap

Name

imap — Gromox IMAP server

Synopsis

imap [-c config]

Options

-c config
Read configuration directives from the given file. If this option is not specified, /etc/gromox/imap.cfg will be read if it exists.
–version
Output version information and exit.
-?
Display option summary.

Configuration directives

The usual config file location is /etc/gromox/imap.cfg.

block_interval_auths
The amount of time a user is blocked from connecting to the service after too many failed logins.
Default: 1 minute
config_file_path
Colon-separated list of directories in which further configuration files, especially those used by plugin instances, will be searched.
Default: /etc/gromox/imap:/etc/gromox
context_average_mem
Default: 128K
context_average_mitem
The expected average upper bound of number of mails for a folder. Together with context_num, this directive controls the size of the memory pool for listings.
Default: 64K
context_max_mem
Default: 2M
context_num
Maximum number of concurrently active sessions.
Default: 200
data_file_path
Colon-separated list of directories in which static data files will be searched.
Default: /usr/share/gromox/imap
default_domain
Default: (system domainname)
default_lang
Default: en
enable_rfc2971_commands
RFC 2971 specifies the “ID” command with which a client can inquire the program name and version of the server. This is disabled by default, as it can facilitate potential attackers’ information gathering.
Default: no
host_id
A unique identifier for this system. It is used in the IMAP protocol greeting lines (positive as well as negative). It is furthermore used as a unique identifier among the set of all midb(8gx) clients to construct filenames for the MIDB database/EML cache. The identifier should only use characters allowed for hostnames.
Default: (system hostname)
imap_auth_times
The number of login tries a user is allowed before the account is blocked.
Default: 10
imap_autologout_time
If an IMAP connection is idle for the given period, the connection is terminated.
Default: 30 minutes
imap_certificate_passwd
The password to unlock TLS certificates.
Default: (unset)
imap_certificate_path
Filesystem path to a certificate file for use with encrypted connection. The complete certificate chain should be present (as there is no other config directive to pull CA certs in).
Default: (unset)
imap_cmd_debug
Log every incoming IMAP command and the return code of the operation in a minimal fashion to stderr. Level 1 emits commands that have failed execution, level 2 emits all commands.
Default: 0
imap_conn_timeout
If an IMAP connection stalls for the given period, the connection is terminated.
Default: 3 minutes
imap_force_starttls
This flag controls whether clients must utilize TLS, either by way of implicit TLS (cf. imap_listen_tls_port), or through the STARTTLS command.
Default: false
imap_lang_path
Path to the file for IMAP folder name translations. If only a basename is specified, the file will be searched in data_file_path.
Default: imap_lang.txt
imap_listen_addr
AF_INET6 socket address to bind the IMAP service to.
Default: ::
imap_listen_port
The TCP port to expose the IMAP protocol service on. (The IP address is fixed to the wildcard address.)
Default: 143
imap_listen_tls_port
The TCP port to expose implicit-TLS IMAP protocol service (IMAPS) on. (The IP address is fixed to the wildcard address.)
Default: (unset)
imap_private_key_path
Filesystem path to the key file needed to unlock the TLS certificate.
Default: (unset)
imap_support_starttls
This flag controls the offering of the STARTTLS extension (RFC 2595) to clients.
Default: false
imap_thread_charge_num
The maximum number of connections that each thread is allowed to process.
Default: 40
imap_thread_init_num
The minimum number of client processing threads to keep around.
Default: 1
running_identity
An unprivileged user account to switch the process to after startup.
Default: gromox
service_plugin_ignore_errors
If set to yes, service plugins that fail to load on startup are ignored. If set to no, the daemon will exit if any plugin cannot be loaded.
Default: no
service_plugin_list
Path to a text file which lists the filenames of service plugins to load, one per line.
Default: (built-in list)
service_plugin_path
Path to a secondary directory where service plugins will be loaded from if a primary search in standard directories (as per ld.so(8)) was unsuccessful.
Default: /usr/lib/gromox
state_path
Directory for runtime variadic data.
Default: /var/lib/gromox
tls_min_proto
The lowest TLS version to offer. Possible values are: tls1.0, tls1.1, tls1.2, and, if supported by the system, tls1.3.
Default: tls1.2

Files

  • data_file_path/imap_code.txt: Mapping from internal IMAP error codes to textual descriptions.
  • data_file_path/imap_lang.txt: Translations for IMAP folder names.
  • /usr/lib/gromox/libgxs_*.so: service plugins

See also

gromox(7), midb_agent(4gx)