pop3lite.conf(5)

NAME
/usr/local/etc/pop3lite.conf - configuration file for pop3lite(8)

SYNTAX
The file /usr/local/etc/pop3lite.conf contains the configuration for the pop3lite(8) program. The configuration file is built up from key and value pairs, separated by an equation (=) sign. A key may only contain alphanumerics, and some other characters, such as dots, underscores, etc. Ideally, values contain only these characters. However, they may contain others. Special characters (the quotation mark, the backslash, and the hash mark) can be escaped by prefixing them with a backslash. However, you only have to escape the backslash if it stands before another special character. To illustrate this, let's look at an example! If you want the parser to interpret a value as
    the quotation mark (") You would write this:
    the quotation mark (\") However, to make it interpret a value as
    the backslash (\) You can write it exactly the same. If you want to quote longer sequences, enclose them in quotation marks. Note that between the quotes, you don't have to escape other quotes. The parser treats a value as a list, with blanks or comas separating the items. Therefore, if you want to put any of these characters in a value, you have to enclose it in double quotes. They can't be escaped otherwise. Leading and trailing spaces are ignored, everything after an unescaped hash mark is treated as comment, and ignored. If a line ends with a single, unescaped backslash, the next line will be treated as if it were appended to the current one. This allows breaking up long lines into shorter ones.

OPTIONS
Although there are built-in options, they're not guaranteed to have any effect, because any module can reimplement any function, thus making an option useless. However, if you read the module's documentation too, there won't be any problem.

AUTO_LOGOUT_TIME
    The time (in minutes) of inactivity after a session is automatically ended. Defaults to 10.

DEFAULT.GREETING
    The default greeting message. Defaults to POP3 server ready.

LISTEN.HOST
    The host name or IP address to listen on in standalone mode. If empty, listen on all possible addresses.

LISTEN.PORT
    The port to listen on in standalone mode. Defaults to 110.

MAILBOX_TEMPLATE
    The path to the mailboxes. This is a template, containing one variable, %s, which will be replaced by the appropriate user name. Defaults to /var/mail/%s.

MAX_CHILDREN
    The maximum number of children to allow. That is, the maximum number of clients that can be served at the same time. The zero value is interpreted as unlimited. Available only in standalone mode. Defaults to 20.

MINIMUM_LOG_LEVEL
    The minimum priority required to log a message. Defaults to 1.

MODULE_DIRS
    A list of directories where modules are stored. Defaults to /usr/local/lib/pop3lite.

MODULE_LIST
    A list of modules to load. They can be specified either via full path, or relative to any directory listed in MODULE_DIRS. By default, this is empty.

QUIT_ON_ERROR
    If this option is specified, POP3Lite will issue an implicit quit if the connection drops or any other error occurs. This violates the RFCs, but may come handy for users using flaky phone lines. By default this is off.

RUN_GID
    The gid to set after authentication. By default, the daemon uses the gid of the logged in user.

SYSLOG.DISABLE
    When this is turned on, all logging to syslog will be disabled. Defaults to no.

FILES
/usr/local/etc/pop3lite.conf

SEE ALSO
pop3lite(8)

AUTHOR
Gergely Nagy <8@free.bsd.hu>