pop3

Name

pop3 — Gromox POP3 server

Synopsis

pop3 [-c config]

Options

-c config

Read configuration directives from the given file. If this option is not specified, /etc/gromox/pop3.cfg will be read if it exists.

–version

Output version information and exit.

-?

Display option summary.

Configuration file directives

block_interval_auths
The amount of time a user is blocked from connecting to the service after too many failed logins.
Default: 1 minute
cdn_cache_path

Default: /var/lib/gromox/cdn

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/pop3:/etc/gromox
console_server_ipFP
An IPv6 address (or v4-mapped address) to expose the management console frontend on.
Default: ::1
console_server_port
The TCP port number to expose the management console frontend on.
Default: 7788
context_average_mem

Default: 256K

context_average_units
Lower clamp is 256.
Default: 1024
context_max_mem

Default: 2M

context_num

Default: 200

data_file_path
Colon-separated list of directories in which static data files will be searched.
Default: /usr/share/gromox/pop3
default_domain

Default: (system domainname)

enable_capa_implementation
When enabled, the server will include an “IMPLEMENTATION” line in the CAPA response (RFC 2449 §6.9). This is disabled by default, as it can facilitate potential attackers’ information gathering.
Default: no
host_id

Default: (system hostname)

listen_port
The TCP port to expose the POP3 protocol service on. (The IP address is fixed to the wildcard address.)
Default: 110
listen_ssl_port
The TCP port to expose implicit-TLS POP3 protocol service (POP3S) on. (The IP address is fixed to the wildcard address.)
Default: (unset)
pop3_auth_times
The number of login tries a user is allowed before the account is blocked.
Default: 3
pop3_certificate_passwd
The password to unlock TLS certificates.
Default: (unset)
pop3_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)
pop3_conn_timeout
If a POP3 connection stalls for the given period, the connection is terminated.
Default: 3 minutes
pop3_force_stls
This flag controls whether clients must utilize TLS, either by way of implicit TLS (cf. listen_ssl_port), or through the STLS command.
Default: false
pop3_private_key_path
Filesystem path to the key file needed to unlock the TLS certificate.
Default: (unset)
pop3_support_stls
This flag controls the offering of the STARTTLS extension/STLS command (RFC 2595) to clients.
Default: false
running_identity
An unprivileged user account to switch the process to after startup. To inhibit the switch, assign the empty value.
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: (unspecified)
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
thread_charge_num
The maximum number of connections that each thread is allowed to process.
Default: 40
thread_init_num
The minimum number of client processing threads to keep around.
Default: 1

Files

  • data_file_path/pop3_code.txt: Mapping from internal POP3 error codes to textual descriptions.

  • /usr/lib/gromox/libgxs_*.so: service plugins

See also

gromox(7), midb_agent(4gx)