ZARAFA-SPOOLER.CFG(5)

NAME
zarafa-spooler.cfg - The Zarafa spooler configuration file

SYNOPSIS

spooler.cfg

DESCRIPTION

The spooler.cfg is a configuration file for the Zarafa Spooler. spooler.cfg contains instructions for the software to set up the logging system and outgoing smtp relay server.

FILE FORMAT

The file consists of one big section, but parameters can be grouped by functionality.

The parameters are written in the form:

name = value

The file is line-based. Each newline-terminated line represents either a comment, nothing or a parameter. A line beginning with `#' is considered a comment, and will be ignored by Zarafa. Parameter names are case sensitive.

The types of parameters for the spooler are: server, smtp and log.

EXPLANATION OF EACH PARAMETER

smtp_server
    Hostname or IP address of the outgoing SMTP server. This server needs to relay mail for your server. Default: localhost

server_socket
    Unix socket to find the connection to the Zarafa server. Default: file:///var/run/zarafa

run_as_user
    After correctly starting, the spooler process will become this user, dropping root privileges. Note that the log file needs to be writeable by this user, and the directory too to create new logfiles after logrotation. This can also be achieved by setting the correct group and permissions. Default value is empty, not changing the user after starting.

run_as_group
    After correctly starting, the spooler process will become this group, dropping root privileges. Default value is empty, not changing the group after starting.

pid_file
    Write the process ID number to this file. Default: /var/run/zarafa-spooler.pid

running_path
    Change directory to this path when running in daemonize mode. When using the -F switch to run in the foreground the directory will not be changed. Default: /

sslkey_file
    Use this file as key to logon to the server. This is only used when server_socket is set to an HTTPS transport. See the zarafa-server(1) manual page on how to setup SSL keys. Default: value not set.

sslkey_pass
    The password of the SSL key file that is set in sslkey_file. Default: value not set.

log_method
    The method which should be used for logging. Valid values are:

    syslog
        Use the Linux system log. All messages will be written to the mail facility. See also syslog.conf(5).

    eventlog
        Use the Windows Event logging interface.

    file
        Log to a file. The filename will be specified in log_file.

    Default: file

log_file
    When logging to a file, specify the filename in this parameter. Use - (minus sign) for stderr output. Default: -

log_timestamp
    Specify whether to prefix each log line with a timestamp in 'file' logging mode. Default: 1

log_level
    The level of output for logging in the range from 0 to 5. 0 means no logging, 5 means full logging. Default: 2

max_threads
    The maximum number of threads used to send outgoing messages. For each email in the outgoing queue a seperate thread will be started in order to allow multiple emails to be send out simultaneously. Default: 5

fax_domain
    When an email is sent to a contact with a FAX type email address, the address will be rewritten to a normal SMTP address, using the scheme: <faxnumber>@<fax_domain>. You can install software in your SMTP server which handles these email addresses to actually fax the message to that number. Default:

fax_international
    When sending an international fax, the number will start with a '+' sign. You can rewrite this to the digits you need to dial when dialing to another country. Default: +

always_send_delegates
    Normally, a user needs to give explicit rights to other users to be able to send under their name. When setting this value to 'yes', the spooler will not check these permissions, and will always send the email with 'On behalf of' headers. This was the default behaviour in installations before Zarafa 6.20. Default: no

RELOADING

The following options are reloadable by sending the zarafa-spooler process a HUP signal:

log_level, max_threads

FILES

/etc/zarafa/spooler.cfg
    The Zarafa spooler configuration file.

AUTHOR

Written by Zarafa.

SEE ALSO

 zarafa-spooler(1)