1ZARAFA-SPOOLER.CF(5) Zarafa user reference ZARAFA-SPOOLER.CF(5)
2
6 zarafa-spooler.cfg - The Zarafa spooler configuration file
7
9 spooler.cfg
10
12 The spooler.cfg is a configuration file for the Zarafa Spooler.
13 spooler.cfg contains instructions for the software to set up the
14 logging system and outgoing smtp relay server.
15
17 The file consists of one big section, but parameters can be grouped by
18 functionality.
19 The parameters are written in the form:
21 name = value
23 The file is line-based. Each newline-terminated line represents either
25 a comment, nothing, a parameter or a directive. A line beginning with
26 `#´ is considered a comment, and will be ignored by Zarafa. Parameter
27 names are case sensitive. Lines beginning with `!´ are directives.
28 Directives are written in the form:
30 !directive [argument(s)]
32 The following directives exist:
34 include
36 Include and process argument
37 Example: !include common.cfg
39
41 smtp_server
42 Hostname or IP address of the outgoing SMTP server. This server
43 needs to relay mail for your server.
44 Default: localhost
46 smtp_port
48 TCP Port number for smtp_server.
49 Default: 25
51 server_socket
53 Unix socket to find the connection to the Zarafa server.
54 Default: file:///var/run/zarafa
56 run_as_user
58 After correctly starting, the spooler process will become this
59 user, dropping root privileges. Note that the log file needs to be
60 writeable by this user, and the directory too to create new
61 logfiles after logrotation. This can also be achieved by setting
62 the correct group and permissions.
63 Default value is empty, not changing the user after starting.
65 run_as_group
67 After correctly starting, the spooler process will become this
68 group, dropping root privileges.
69 Default value is empty, not changing the group after starting.
71 pid_file
73 Write the process ID number to this file. This is used by the
74 init.d script to correctly stop/restart the service.
75 Default: /var/run/zarafa-spooler.pid
77 running_path
79 Change directory to this path when running in daemonize mode. When
80 using the -F switch to run in the foreground the directory will not
81 be changed.
82 Default: /
84 sslkey_file
86 Use this file as key to logon to the server. This is only used when
87 server_socket is set to an HTTPS transport. See the zarafa-
88 server(1) manual page on how to setup SSL keys.
89 Default: value not set.
91 sslkey_pass
93 The password of the SSL key file that is set in sslkey_file.
94 Default: value not set.
96 log_method
98 The method which should be used for logging. Valid values are:
99 syslog
101 Use the Linux system log. All messages will be written to the
102 mail facility. See also syslog.conf(5).
103 file
105 Log to a file. The filename will be specified in log_file.
106 Default: file
108 log_file
110 When logging to a file, specify the filename in this parameter. Use
111 - (minus sign) for stderr output.
112 Default: -
114 log_timestamp
116 Specify whether to prefix each log line with a timestamp in ´file´
117 logging mode.
118 Default: 1
120 log_level
122 The level of output for logging in the range from 0 to 5. 0 means
123 no logging, 5 means full logging.
124 Default: 2
126 max_threads
128 The maximum number of threads used to send outgoing messages. For
129 each email in the outgoing queue a seperate thread will be started
130 in order to allow multiple emails to be send out simultaneously.
131 Default: 5
133 fax_domain
135 When an email is sent to a contact with a FAX type email address,
136 the address will be rewritten to a normal SMTP address, using the
137 scheme: <faxnumber>@<fax_domain>. You can install software in your
138 SMTP server which handles these email addresses to actually fax the
139 message to that number.
140 Default:
142 fax_international
144 When sending an international fax, the number will start with a ´+´
145 sign. You can rewrite this to the digits you need to dial when
146 dialing to another country.
147 Default: +
149 always_send_delegates
151 Normally, a user needs to give explicit rights to other users to be
152 able to send under their name. When setting this value to ´yes´,
153 the spooler will not check these permissions, and will always send
154 the email with ´On behalf of´ headers. This was the default
155 behaviour in installations before Zarafa 6.20. Please note that
156 this feature overrides ´send-as´ functionality.
157 Default: no
159 always_send_tnef
161 Since Zarafa 6.30, meeting requests will be sent using iCalendar
162 files. This adds compatibility to more calendar programs. To use
163 the previous TNEF (winmail.dat) method, set this option to ´yes´.
164 Default: no
166 always_send_utf8
168 E-mails can be sent in any charset that the e-mail was written in.
169 It may be desirable to always send in the UTF-8 charset, which may
170 be more widely supported. To enable e-mail to always be sent in the
171 utf-8 charset, set this option to ´yes´.
172 Default: no
174 allow_redirect_spoofing
176 Normally, users are not allowed to send e-mail from a different
177 e-mail address than their own. However, the ´redirect´ rule sends
178 e-mails with their original ´from´ address. Enabling this option
179 allows redirected e-mails to be sent with their original ´from´
180 e-mail address.
181 Default: yes
183 copy_delegate_mails
185 Make a copy of the sent mail of delegates in the sent items folder
186 of the representee. This is done for both delegate and send-as
187 e-mails.
188 Default: yes
190 allow_delegate_meeting_request
192 Normally, users are not allowed to send meeting requests as
193 external delegate. However, when you want to forward meeting
194 requests you need delegate permissions. Enabling this option allows
195 you to sent and forward a meeting request as a delegate Zarafa and
196 SMTP user.
197 Default: yes
199 allow_send_to_everyone
201 When set to ´no´, sending to the ´everyone´ group is disallowed.
202 The entire message will be bounced if this is attempted. When set
203 to ´yes´, this allows sending to all users in the ´everyone´ group.
204 Default: yes
206 expand_groups
208 Expand groups in headers of sent e-mails. This means that the
209 recipient of an e-mail with one or more groups as recipients will
210 see the members of the groups instead of the groups themselves. If
211 a group has an e-mail address, the group is not expanded
212 irrespective of this setting, since having an e-mail address for
213 the group implies that this address can be used to send messages to
214 the group.
215 Default: no
217 archive_on_send
219 Archive outgoing messages. If an archive is attached to the mailbox
220 from which a message is send, the message will immediately be
221 archived to the special Outgoing folder.
222 Messages that are archived this way are not attached to the
224 original message in the primary store. So there´s no easy way to
225 find the original sent item based on an archive or find an archive
226 based on the sent item in the primary store. This option is only
227 intended to make sure all outgoing messages are stored without the
228 possibility for the owner to delete them.
229 Default: no
231
233 The following options are reloadable by sending the zarafa-spooler
234 process a HUP signal:
235 log_level, max_threads, archive_on_send
237
239 /etc/zarafa/spooler.cfg
240 The Zarafa spooler configuration file.
241
243 Written by Zarafa.
244
246 zarafa-spooler(1)
247Zarafa 7.0 August 2011 ZARAFA-SPOOLER.CF(5)