Ubuntu Manpage: kopano-spooler.cfg - The Kopano spooler configuration file

Provided by: kopano-spooler_8.7.0-7.1ubuntu10.1_amd64

NAME

       kopano-spooler.cfg - The Kopano spooler configuration file

SYNOPSIS

       spooler.cfg

DESCRIPTION

       The spooler.cfg is a configuration file for the Kopano 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, a parameter or
       a directive. A line beginning with `#' is considered a comment, and will be ignored by Kopano. Parameter
       names are case sensitive. Lines beginning with `!' are directives.

       Directives are written in the form:

       !directive [argument(s)]

       The following directives exist:

       include
           Include and process argument

           Example: !include common.cfg

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

smtp_port
TCP Port number for smtp_server.

Default: 25

server_socket
Unix socket to find the connection to the Kopano server.

Default: file:///var/run/kopano/server.sock

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. This is used by the init.d script to correctly stop/restart the
service.

Default: /var/run/kopano/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: /

coredump_enabled
When a crash occurs or an assertion fails, a coredump file can be generated by the system for use with a
crash report. For details, see the kopano-coredump(5) manpage.

Default: systemdefault

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 kopano-server(8) 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 syslog service. Messages will be sent using the "mail" facility tag. See also
journald.conf(5) or syslog.conf(5).

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

auto Autoselect mode: If log_file is set, that will be used. Else, syslog will be used if it looks
like it is available. Else, stderr.

Default: auto

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_buffer_size
Buffer logging in what sized blocks. The special value 0 selects line buffering.

Default: 0

log_level
The level of output for logging in the range from 0 to 6. "0" means no logging, "1" for critical messages
only, "2" for error or worse, "3" for warning or worse, "4" for notice or worse, "5" for info or worse,
"6" debug.

Default: 3

log_raw_message_stage1
Log the raw message to a file. In stage 1, not all recipients are necessarily resolved yet, and
Bcc is still visible; this is not the exact mail that is delivered to the SMTP server. The file is
saved to the location specified in log_raw_message_path. Default: no.

log_raw_message_path
Path to save the raw message to.

Default: /var/lib/kopano

max_threads

The maximum number of threads used to send outgoing messages. For each email in the outgoing queue a
separate thread will be started in order to allow multiple emails to be sent 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. Please note that this feature overrides 'send-as' functionality.

Default: no

always_send_tnef
Meeting requests will be sent using iCalendar files. This adds compatibility to more calendar programs.
To use the previous TNEF (winmail.dat) method, set this option to 'yes'.

When an email body is written in RTF text, normally this data is sent using TNEF. If you want to send an
HTML representation of the email instead and not use TNEF, set this to 'minimal'.

Default: no

enable_dsn
Enable the Delivery Status Notifications (DSN) for users. If a user requests a DSN the spooler sends the
request to the MTA and when the MTA support this the user will receive the report in the mailbox. When
the MTA doesn't support DSN the user will not receive a report. Ensure you have a supported MTA like
postfix 2.3 and higher. If DSN is disabled and the user request a DSN then it will be ignored and the
delivery report is not sent.

Default: yes

charset_upgrade
Upgrades the us-ascii charset to this charset. This makes sure high-characters in recipients and
attachment filenames are correctly sent when the body is in plain text.

Default: windows-1252

allow_redirect_spoofing
Normally, users are not allowed to send e-mail from a different e-mail address than their own. However,
the 'redirect' rule sends e-mails with their original 'from' address. Enabling this option allows
redirected e-mails to be sent with their original 'from' e-mail address.

Default: yes

copy_delegate_mails
This directive controls into which "Sent Items" folder(s) an e-mail message will be placed when sending
messages. This applies to both these types of delegation:

• "on behalf of", where, in RFC 5322 terms, the From: line is changed, and a Sender: line is added.

• "send as", where the From: line is changed, and no Sender: line is emitted.

Possible values are: no (message stays with delegate's "Sent Items"), yes (message is copied to
representee's "Sent Items"), move-to-rep (message is moved from delegate to representee).

Some MAPI clients (such as Outlook with the Zarafa DLL) may independently retain and store a copy of the
message into "Sent Items", unbeknownst to kopano-spooler, thereby defeating the effectiveness of move-to-
rep.

Default: yes

allow_delegate_meeting_request
Normally, users are not allowed to send meeting requests as external delegate. However, when you want to
forward meeting requests you need delegate permissions. Enabling this option allows you to sent and
forward a meeting request as a delegate Kopano and SMTP user.

Default: yes

allow_send_to_everyone
When set to 'no', sending to the 'everyone' group is disallowed. The entire message will be bounced if
this is attempted. When set to 'yes', this allows sending to all users in the 'everyone' group.

Default: yes

expand_groups
Expand groups in headers of sent e-mails. This means that the recipient of an e-mail with one or more
groups as recipients will see the members of the groups instead of the groups themselves. If a group has
an e-mail address, the group is not expanded irrespective of this setting, since having an e-mail address
for the group implies that this address can be used to send messages to the group.

Default: no

archive_on_send
Archive outgoing messages. If an archive is attached to the mailbox from which a message is send, the
message will immediately be archived to the special Outgoing folder.

Messages that are archived this way are not attached to the original message in the primary store. So
there's no easy way to find the original sent item based on an archive or find an archive based on the
sent item in the primary store. This option is only intended to make sure all outgoing messages are
stored without the possibility for the owner to delete them.

Default: no

plugin_enabled
Enable or disable the spooler plugin framework.

Default: yes

plugin_manager_path
The path to the spooler plugin manager.

Default: /usr/share/kopano-spooler/python

plugin_path
Path to the activated spooler plugins. This folder contains symlinks to the kopano plugins and custom
scripts. The plugins are installed in /usr/share/kopano-spooler/python/plugins. To activate a plugin
create a symbolic link in the plugin_path directory.

Example:

ln -s /usr/share/kopano-spooler/python/plugins/BMP2PNG.py /var/lib/kopano/spooler/plugins/BMP2PNG.py

Default: /var/lib/kopano/spooler/plugins

statsclient_url
A HTTP URL or filesystem-local socket specification for a kopano-statsd compatible web service that
ingests service statistics such as memory usage or mail processing counters.

Example: https://my.local.org/collector.php

Default: unix:/var/run/kopano/statsd.sock

statsclient_interval
The time interval at which the statsd service is to be contacted, in seconds. When "statsclient_url"
points to a kopano-statsd instance, the value should be 60 (for now), because its rrdtool archives are
set to expect data at this rate.

Default: 0 (submission service is deactivated)

statsclient_ssl_verify
This setting can be used to control SSL certificate validation.

Default: yes

RELOADING

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

       log_level, max_threads, archive_on_send

FILES

       /etc/kopano/spooler.cfg
           The Kopano spooler configuration file.

AUTHOR

       Written by Kopano.

NAME

SYNOPSIS

DESCRIPTION

FILE FORMAT

EXPLANATION OF EACH PARAMETER

RELOADING

FILES

AUTHOR

SEE ALSO