Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 861 lines (680 sloc) 36.42 kB
4e17e6c @thomascube Initial revision
thomascube authored
1 <?php
2
3 /*
4 +-----------------------------------------------------------------------+
5 | Main configuration file |
6 | |
e019f2d @alecpl - s/RoundCube/Roundcube/
alecpl authored
7 | This file is part of the Roundcube Webmail client |
62c8618 @thomascube Make email recipients separator configurable + suppress dupes in auto…
thomascube authored
8 | Copyright (C) 2005-2011, The Roundcube Dev Team |
7fe3811 @thomascube Changed license to GNU GPLv3+ with exceptions for skins and plugins
thomascube authored
9 | |
10 | Licensed under the GNU General Public License version 3 or |
11 | any later version with exceptions for skins & plugins. |
12 | See the README file for a full license statement. |
4e17e6c @thomascube Initial revision
thomascube authored
13 | |
14 +-----------------------------------------------------------------------+
15
16 */
17
18 $rcmail_config = array();
19
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
20 // ----------------------------------
21 // LOGGING/DEBUGGING
22 // ----------------------------------
23
e077c18 @alecpl Corrected description if debug_level
alecpl authored
24 // system error reporting, sum of: 1 = log; 4 = show, 8 = trace
13c1afb @thomascube Fixed some charset bugs
thomascube authored
25 $rcmail_config['debug_level'] = 1;
4e17e6c @thomascube Initial revision
thomascube authored
26
b77d0dd @alecpl - added options to use syslog instead of log file (#1484850)
alecpl authored
27 // log driver: 'syslog' or 'file'.
28 $rcmail_config['log_driver'] = 'file';
29
0ad27c3 @alecpl - Added log_date_format option (#1485709)
alecpl authored
30 // date format for log entries
31 // (read http://php.net/manual/en/function.date.php for all format characters)
32 $rcmail_config['log_date_format'] = 'd-M-Y H:i:s O';
33
b77d0dd @alecpl - added options to use syslog instead of log file (#1484850)
alecpl authored
34 // Syslog ident string to use, if using the 'syslog' log driver.
35 $rcmail_config['syslog_id'] = 'roundcube';
36
37 // Syslog facility to use, if using the 'syslog' log driver.
38 // For possible values see installer or http://php.net/manual/en/function.openlog.php
39 $rcmail_config['syslog_facility'] = LOG_USER;
40
3e34297 @alecpl - describe log_logins/smtp_log file names
alecpl authored
41 // Log sent messages to <log_dir>/sendmail or to syslog
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
42 $rcmail_config['smtp_log'] = true;
b77d0dd @alecpl - added options to use syslog instead of log file (#1484850)
alecpl authored
43
3e34297 @alecpl - describe log_logins/smtp_log file names
alecpl authored
44 // Log successful logins to <log_dir>/userlogins or to syslog
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
45 $rcmail_config['log_logins'] = false;
b77d0dd @alecpl - added options to use syslog instead of log file (#1484850)
alecpl authored
46
fcc7f86 @thomascube Log session validation errors; keep error message when redirecting to…
thomascube authored
47 // Log session authentication errors to <log_dir>/session or to syslog
48 $rcmail_config['log_session'] = false;
49
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
50 // Log SQL queries to <log_dir>/sql or to syslog
51 $rcmail_config['sql_debug'] = false;
cc97ea0 @thomascube Merged branch devel-api (from r2208 to r2387) back into trunk (omitti…
thomascube authored
52
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
53 // Log IMAP conversation to <log_dir>/imap or to syslog
54 $rcmail_config['imap_debug'] = false;
6dc0269 @thomascube Make message caching configurable
thomascube authored
55
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
56 // Log LDAP conversation to <log_dir>/ldap or to syslog
57 $rcmail_config['ldap_debug'] = false;
cc95700 @thomascube Added message cache garbage collector
thomascube authored
58
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
59 // Log SMTP conversation to <log_dir>/smtp or to syslog
60 $rcmail_config['smtp_debug'] = false;
f5d61d8 @thomascube Revert r3038 and allow to specify the port as value of force_https
thomascube authored
61
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
62 // ----------------------------------
63 // IMAP
64 // ----------------------------------
4e17e6c @thomascube Initial revision
thomascube authored
65
66 // the mail host chosen to perform the log-in
67 // leave blank to show a textbox at login, give a list of hosts
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
68 // to display a pulldown menu or set one host as string.
f86e8f5 @alecpl - Support STARTTLS in IMAP connection (#1485284)
alecpl authored
69 // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
bb8721a @alecpl - Support dynamic hostname (%d/%n) variables in configuration options…
alecpl authored
70 // Supported replacement variables:
d359dcb @bes-internal use in parse_host HTTP_HOST for %d
bes-internal authored
71 // %n - hostname ($_SERVER['SERVER_NAME'])
72 // %t - hostname without the first part
73 // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
b04c51f @vbenincasa - Added the %s variable in 'default_host' and 'smtp_server' option (…
vbenincasa authored
74 // %s - domain name after the '@' from e-mail address provided at login screen
d359dcb @bes-internal use in parse_host HTTP_HOST for %d
bes-internal authored
75 // For example %n = mail.domain.tld, %t = domain.tld
4e17e6c @thomascube Initial revision
thomascube authored
76 $rcmail_config['default_host'] = '';
77
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
78 // TCP port used for IMAP connections
79 $rcmail_config['default_port'] = 143;
80
4dd4172 @alecpl - Add support for AUTH=DIGEST-MD5 in IMAP (RFC 2831)
alecpl authored
81 // IMAP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
82 // best server supported one)
b026c3b @thomascube Make IMAP auth type configurable (#1483825)
thomascube authored
83 $rcmail_config['imap_auth_type'] = null;
84
00290a6 @alecpl - Add support for shared folders (#1403507)
alecpl authored
85 // If you know your imap's folder delimiter, you can specify it here.
86 // Otherwise it will be determined automatically
030c848 @alecpl - Performance: allow setting imap rootdir and delimiter before connec…
alecpl authored
87 $rcmail_config['imap_delimiter'] = null;
88
00290a6 @alecpl - Add support for shared folders (#1403507)
alecpl authored
89 // If IMAP server doesn't support NAMESPACE extension, but you're
90 // using shared folders or personal root folder is non-empty, you'll need to
91 // set these options. All can be strings or arrays of strings.
e3af1f2 @alecpl - Added comment about imap_ns_* settings
alecpl authored
92 // Folders need to be ended with directory separator, e.g. "INBOX."
93 // (special directory "~" is an exception to this rule)
02491a9 @alecpl - Make possible to overwrite server's namespaces with imap_ns_* options
alecpl authored
94 // These can be used also to overwrite server's namespaces
00290a6 @alecpl - Add support for shared folders (#1403507)
alecpl authored
95 $rcmail_config['imap_ns_personal'] = null;
96 $rcmail_config['imap_ns_other'] = null;
97 $rcmail_config['imap_ns_shared'] = null;
98
d8c440c @alecpl - Added 'imap_force_caps' option for after-login CAPABILITY checking …
alecpl authored
99 // By default IMAP capabilities are readed after connection to IMAP server
100 // In some cases, e.g. when using IMAP proxy, there's a need to refresh the list
101 // after login. Set to True if you've got this case.
102 $rcmail_config['imap_force_caps'] = false;
103
f75f65c @alecpl - Added option imap_force_lsub for some buggy LIST-EXTENDED implement…
alecpl authored
104 // By default list of subscribed folders is determined using LIST-EXTENDED
105 // extension if available. Some servers (dovecot 1.x) returns wrong results
106 // for shared namespaces in this case. http://trac.roundcube.net/ticket/1486225
107 // Enable this option to force LSUB command usage instead.
108 $rcmail_config['imap_force_lsub'] = false;
109
3c5489b @alecpl Add option imap_force_ns to make buggy servers support optional
alecpl authored
110 // Some server configurations (e.g. Courier) doesn't list folders in all namespaces
111 // Enable this option to force listing of folders in all namespaces
112 $rcmail_config['imap_force_ns'] = false;
113
f07d238 @alecpl - Add 'imap_timeout' option (#1486760)
alecpl authored
114 // IMAP connection timeout, in seconds. Default: 0 (no limit)
115 $rcmail_config['imap_timeout'] = 0;
116
a1fe6bd @alecpl - Add support for IMAP proxy authentication (#1486690)
alecpl authored
117 // Optional IMAP authentication identifier to be used as authorization proxy
118 $rcmail_config['imap_auth_cid'] = null;
119
120 // Optional IMAP authentication password to be used for imap_auth_cid
121 $rcmail_config['imap_auth_pw'] = null;
122
8edb3d9 @alecpl - Add APC support in rcube_cache
alecpl authored
123 // Type of IMAP indexes cache. Supported values: 'db', 'apc' and 'memcache'.
5cf5ee6 @alecpl - Added general rcube_cache class with memcache support
alecpl authored
124 $rcmail_config['imap_cache'] = null;
125
126 // Enables messages cache. Only 'db' cache is supported.
127 $rcmail_config['messages_cache'] = false;
128
129
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
130 // ----------------------------------
131 // SMTP
132 // ----------------------------------
f88d417 @thomascube Applied several patches
thomascube authored
133
c3b6763 @alecpl - added warning about using TLS with SMTP
alecpl authored
134 // SMTP server host (for sending mails).
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
135 // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
c3b6763 @alecpl - added warning about using TLS with SMTP
alecpl authored
136 // If left blank, the PHP mail() function is used
bb8721a @alecpl - Support dynamic hostname (%d/%n) variables in configuration options…
alecpl authored
137 // Supported replacement variables:
138 // %h - user's IMAP hostname
d359dcb @bes-internal use in parse_host HTTP_HOST for %d
bes-internal authored
139 // %n - hostname ($_SERVER['SERVER_NAME'])
140 // %t - hostname without the first part
141 // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
11be933 @alecpl - Support %z variable in host configuration options (#1487003)
alecpl authored
142 // %z - IMAP domain (IMAP hostname without the first part)
d359dcb @bes-internal use in parse_host HTTP_HOST for %d
bes-internal authored
143 // For example %n = mail.domain.tld, %t = domain.tld
4e17e6c @thomascube Initial revision
thomascube authored
144 $rcmail_config['smtp_server'] = '';
145
e52aaee @thomascube Mention smtp ports 587 and 465 in config template
thomascube authored
146 // SMTP port (default is 25; use 587 for STARTTLS or 465 for the
147 // deprecated SSL over SMTP (aka SMTPS))
968bdc7 @thomascube Improved SMTP script for sending mails. Now using the PEAR::Net_SMTP …
thomascube authored
148 $rcmail_config['smtp_port'] = 25;
149
e019f2d @alecpl - s/RoundCube/Roundcube/
alecpl authored
150 // SMTP username (if required) if you use %u as the username Roundcube
d206c1f added smtp auth method setting through config file
svncommit authored
151 // will use the current username for login
4e17e6c @thomascube Initial revision
thomascube authored
152 $rcmail_config['smtp_user'] = '';
153
e019f2d @alecpl - s/RoundCube/Roundcube/
alecpl authored
154 // SMTP password (if required) if you use %p as the password Roundcube
d206c1f added smtp auth method setting through config file
svncommit authored
155 // will use the current user's password for login
4e17e6c @thomascube Initial revision
thomascube authored
156 $rcmail_config['smtp_pass'] = '';
157
d206c1f added smtp auth method setting through config file
svncommit authored
158 // SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
159 // best server supported one)
160 $rcmail_config['smtp_auth_type'] = '';
161
63d4d61 @alecpl - Re-implemented SMTP proxy authorization support
alecpl authored
162 // Optional SMTP authentication identifier to be used as authorization proxy
163 $rcmail_config['smtp_auth_cid'] = null;
164
a1fe6bd @alecpl - Add support for IMAP proxy authentication (#1486690)
alecpl authored
165 // Optional SMTP authentication password to be used for smtp_auth_cid
63d4d61 @alecpl - Re-implemented SMTP proxy authorization support
alecpl authored
166 $rcmail_config['smtp_auth_pw'] = null;
a392125 @alecpl - Add SASL proxy authentication for SMTP (#1486693)
alecpl authored
167
aca3d25 Make smtp HELO/EHLO hostname configurable (closes #1484067)
svncommit authored
168 // SMTP HELO host
169 // Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages
170 // Leave this blank and you will get the server variable 'server_name' or
171 // localhost if that isn't defined.
172 $rcmail_config['smtp_helo_host'] = '';
173
f07d238 @alecpl - Add 'imap_timeout' option (#1486760)
alecpl authored
174 // SMTP connection timeout, in seconds. Default: 0 (no limit)
175 $rcmail_config['smtp_timeout'] = 0;
176
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
177 // ----------------------------------
178 // SYSTEM
179 // ----------------------------------
64608bf @alecpl - Password: Make passwords encoding consistent with core, add 'passwo…
alecpl authored
180
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
181 // THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA.
182 // ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING!
183 $rcmail_config['enable_installer'] = false;
4e17e6c @thomascube Initial revision
thomascube authored
184
c04b23a @thomascube - replace claim in Roundcube logo
thomascube authored
185 // provide an URL where a user can get support for this Roundcube installation
186 // PLEASE DO NOT LINK TO THE ROUNDCUBE.NET WEBSITE HERE!
187 $rcmail_config['support_url'] = '';
188
189 // replace Roundcube logo with this image
190 // specify an URL relative to the document root of this Roundcube installation
191 $rcmail_config['skin_logo'] = null;
192
193 // automatically create a new Roundcube user when log-in the first time.
194 // a new user will be created once the IMAP login succeeds.
195 // set to false if only registered users can use this service
196 $rcmail_config['auto_create_user'] = true;
197
565c472 @alecpl Removed users.alias column, added option ('user_aliases')
alecpl authored
198 // Enables possibility to log in using email address from user identities
199 $rcmail_config['user_aliases'] = false;
200
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
201 // use this folder to store log files (must be writeable for apache user)
202 // This is used by the 'file' log driver.
203 $rcmail_config['log_dir'] = 'logs/';
d559cba @alecpl - Added 'imap_debug' option, described 'sql_debug' option in config file
alecpl authored
204
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
205 // use this folder to store temp files (must be writeable for apache user)
206 $rcmail_config['temp_dir'] = 'temp/';
d559cba @alecpl - Added 'imap_debug' option, described 'sql_debug' option in config file
alecpl authored
207
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
208 // lifetime of message cache
209 // possible units: s, m, h, d, w
210 $rcmail_config['message_cache_lifetime'] = '10d';
19862b5 @alecpl - added 'smtp_debug' option
alecpl authored
211
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
212 // enforce connections over https
213 // with this option enabled, all non-secure connections will be redirected.
214 // set the port for the ssl connection as value of this option if it differs from the default 443
215 $rcmail_config['force_https'] = false;
00e18b7 @alecpl - Add description of 'use_https' option in main.inc.php.dist file
alecpl authored
216
217 // tell PHP that it should work as under secure connection
218 // even if it doesn't recognize it as secure ($_SERVER['HTTPS'] is not set)
219 // e.g. when you're running Roundcube behind a https proxy
377bc60 @thomascube Add a note that 'use_https' and 'force_https' are mutually exclusive
thomascube authored
220 // this option is mutually exclusive to 'force_https' and only either one of them should be set to true.
00e18b7 @alecpl - Add description of 'use_https' option in main.inc.php.dist file
alecpl authored
221 $rcmail_config['use_https'] = false;
acb08f5 @alecpl - Added 'sendmail_delay' option to restrict messages sending interval…
alecpl authored
222
1cca4fb @alecpl - Allow setting autocomplete attribute for all inputs separately (#14…
alecpl authored
223 // Allow browser-autocompletion on login form.
224 // 0 - disabled, 1 - username and host only, 2 - username, host, password
225 $rcmail_config['login_autocomplete'] = 0;
fbe24e9 @thomascube Allow plugin templates to include local files (#1487133); make autoco…
thomascube authored
226
c72325f @alecpl Fix bug where domain name was converted to lower-case even with login…
alecpl authored
227 // Forces conversion of logins to lower case.
228 // 0 - disabled, 1 - only domain part, 2 - domain and local part.
229 // If users authentication is not case-sensitive this must be enabled.
caedd52 @alecpl - Add comment for login_lc option (#1487681)
alecpl authored
230 // After enabling it all user records need to be updated, e.g. with query:
231 // UPDATE users SET username = LOWER(username);
c72325f @alecpl Fix bug where domain name was converted to lower-case even with login…
alecpl authored
232 $rcmail_config['login_lc'] = 0;
e17553d @alecpl - Add 'login_lc' config option for case-insensitive authentication (#…
alecpl authored
233
95d90f8 @alecpl - Added 'keep_alive' and 'min_keep_alive' options (#1485360)
alecpl authored
234 // Includes should be interpreted as PHP files
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
235 $rcmail_config['skin_include_php'] = false;
5eee009 @thomascube Allow vars and PHP code in templates; improved page title; fixed #148…
thomascube authored
236
b6267da @thomascube Hide product version on login screen by default
thomascube authored
237 // display software version on login screen
238 $rcmail_config['display_version'] = false;
239
95d90f8 @alecpl - Added 'keep_alive' and 'min_keep_alive' options (#1485360)
alecpl authored
240 // Session lifetime in minutes
241 // must be greater than 'keep_alive'/60
7902df4 @thomascube Fixed SSL support; improved Courier compatibility; some visual enhanc…
thomascube authored
242 $rcmail_config['session_lifetime'] = 10;
243
ae7027d @alecpl Added session_path config option and unified cookies settings in java…
alecpl authored
244 // Session domain: .example.org
cf2da2f @thomascube Improve session validity check with changing auth cookies; reduce wri…
thomascube authored
245 $rcmail_config['session_domain'] = '';
246
ae7027d @alecpl Added session_path config option and unified cookies settings in java…
alecpl authored
247 // Session name. Default: 'roundcube_sessid'
bd34cad @alecpl - Add option to set session name (#1486433)
alecpl authored
248 $rcmail_config['session_name'] = null;
249
ae7027d @alecpl Added session_path config option and unified cookies settings in java…
alecpl authored
250 // Session path. Defaults to PHP session.cookie_path setting.
251 $rcmail_config['session_path'] = null;
252
63e9927 @thomascube Add support for session storage using memcache
thomascube authored
253 // Backend to use for session storage. Can either be 'db' (default) or 'memcache'
254 // If set to memcache, a list of servers need to be specified in 'memcache_hosts'
255 // Make sure the Memcache extension (http://pecl.php.net/package/memcache) version >= 2.0.0 is installed
256 $rcmail_config['session_storage'] = 'db';
257
258 // Use these hosts for accessing memcached
71ee565 @alecpl Support connections to memcached socket file (#1488577)
alecpl authored
259 // Define any number of hosts in the form of hostname:port or unix:///path/to/socket.file
260 $rcmail_config['memcache_hosts'] = null; // e.g. array( 'localhost:11211', '192.168.1.12:11211', 'unix:///var/tmp/memcached.sock' );
63e9927 @thomascube Add support for session storage using memcache
thomascube authored
261
4e17e6c @thomascube Initial revision
thomascube authored
262 // check client IP in session athorization
aad6e2a @thomascube New session authentication, should fix bugs #1483951 and #1484299; te…
thomascube authored
263 $rcmail_config['ip_check'] = false;
264
a77cf22 @thomascube Add optional referer check to prevent CSRF in GET requests
thomascube authored
265 // check referer of incoming requests
266 $rcmail_config['referer_check'] = false;
267
c170bfc @thomascube Protect from Clickjacking by sending X-Frame-Options headers (#1487037)
thomascube authored
268 // X-Frame-Options HTTP header value sent to prevent from Clickjacking.
269 // Possible values: sameorigin|deny. Set to false in order to disable sending them
67eecde @alecpl - Fix typo
alecpl authored
270 $rcmail_config['x_frame_options'] = 'sameorigin';
c170bfc @thomascube Protect from Clickjacking by sending X-Frame-Options headers (#1487037)
thomascube authored
271
bac7d17 @thomascube Fixed bugs #1364122, #1468895, ticket #1483811 and other minor bugs
thomascube authored
272 // this key is used to encrypt the users imap password which is stored
273 // in the session record (and the client cookie if remember password is enabled).
274 // please provide a string of exactly 24 chars.
275 $rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str';
276
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
277 // Automatically add this domain to user names for login
278 // Only for IMAP servers that require full e-mail addresses for login
279 // Specify an array with 'host' => 'domain' values to support multiple hosts
6a642d1 @alecpl - support dynamic hostname variables in 'username_domain' option
alecpl authored
280 // Supported replacement variables:
281 // %h - user's IMAP hostname
d359dcb @bes-internal use in parse_host HTTP_HOST for %d
bes-internal authored
282 // %n - hostname ($_SERVER['SERVER_NAME'])
283 // %t - hostname without the first part
284 // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
11be933 @alecpl - Support %z variable in host configuration options (#1487003)
alecpl authored
285 // %z - IMAP domain (IMAP hostname without the first part)
d359dcb @bes-internal use in parse_host HTTP_HOST for %d
bes-internal authored
286 // For example %n = mail.domain.tld, %t = domain.tld
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
287 $rcmail_config['username_domain'] = '';
288
289 // This domain will be used to form e-mail addresses of new users
290 // Specify an array with 'host' => 'domain' values to support multiple hosts
bb8721a @alecpl - Support dynamic hostname (%d/%n) variables in configuration options…
alecpl authored
291 // Supported replacement variables:
292 // %h - user's IMAP hostname
293 // %n - http hostname ($_SERVER['SERVER_NAME'])
294 // %d - domain (http hostname without the first part)
11be933 @alecpl - Support %z variable in host configuration options (#1487003)
alecpl authored
295 // %z - IMAP domain (IMAP hostname without the first part)
d359dcb @bes-internal use in parse_host HTTP_HOST for %d
bes-internal authored
296 // For example %n = mail.domain.tld, %t = domain.tld
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
297 $rcmail_config['mail_domain'] = '';
298
299 // Password charset.
300 // Use it if your authentication backend doesn't support UTF-8.
301 // Defaults to ISO-8859-1 for backward compatibility
302 $rcmail_config['password_charset'] = 'ISO-8859-1';
303
304 // How many seconds must pass between emails sent by a user
305 $rcmail_config['sendmail_delay'] = 0;
306
751b22b @alecpl - Added optional (max_recipients) support to restrict total number of…
alecpl authored
307 // Maximum number of recipients per message. Default: 0 (no limit)
308 $rcmail_config['max_recipients'] = 0;
309
d1851ba @thomascube Configurable limit of address group members
thomascube authored
310 // Maximum allowednumber of members of an address group. Default: 0 (no limit)
311 // If 'max_recipients' is set this value should be less or equal
312 $rcmail_config['max_group_members'] = 0;
313
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
314 // add this user-agent to message headers when sending
6b6f2e8 @thomascube Display and send messages with format=flowed (#1484370), fixes word w…
thomascube authored
315 $rcmail_config['useragent'] = 'Roundcube Webmail/'.RCMAIL_VERSION;
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
316
317 // use this name to compose page titles
6b6f2e8 @thomascube Display and send messages with format=flowed (#1484370), fixes word w…
thomascube authored
318 $rcmail_config['product_name'] = 'Roundcube Webmail';
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
319
320 // try to load host-specific configuration
321 // see http://trac.roundcube.net/wiki/Howto_Config for more details
322 $rcmail_config['include_host_config'] = false;
323
324 // path to a text file which will be added to each sent message
e019f2d @alecpl - s/RoundCube/Roundcube/
alecpl authored
325 // paths are relative to the Roundcube root folder
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
326 $rcmail_config['generic_message_footer'] = '';
327
5852c14 @alecpl - Add option to set separate footer for HTML messages (#1486660)
alecpl authored
328 // path to a text file which will be added to each sent HTML message
e019f2d @alecpl - s/RoundCube/Roundcube/
alecpl authored
329 // paths are relative to the Roundcube root folder
5852c14 @alecpl - Add option to set separate footer for HTML messages (#1486660)
alecpl authored
330 $rcmail_config['generic_message_footer_html'] = '';
331
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
332 // add a received header to outgoing mails containing the creators IP and hostname
333 $rcmail_config['http_received_header'] = false;
334
335 // Whether or not to encrypt the IP address and the host name
336 // these could, in some circles, be considered as sensitive information;
337 // however, for the administrator, these could be invaluable help
338 // when tracking down issues.
339 $rcmail_config['http_received_header_encrypt'] = false;
340
ac8edbe @alecpl - Fix use RFC-compliant line-delimiter when saving messages on IMAP (…
alecpl authored
341 // This string is used as a delimiter for message headers when sending
342 // a message via mail() function. Leave empty for auto-detection
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
343 $rcmail_config['mail_header_delimiter'] = NULL;
344
6b6f2e8 @thomascube Display and send messages with format=flowed (#1484370), fixes word w…
thomascube authored
345 // number of chars allowed for line when wrapping text.
346 // text wrapping is done when composing/sending messages
c769c66 @thomascube Default line length is 72
thomascube authored
347 $rcmail_config['line_length'] = 72;
6b6f2e8 @thomascube Display and send messages with format=flowed (#1484370), fixes word w…
thomascube authored
348
349 // send plaintext messages as format=flowed
350 $rcmail_config['send_format_flowed'] = true;
351
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
352 // don't allow these settings to be overriden by the user
353 $rcmail_config['dont_override'] = array();
354
355 // Set identities access level:
356 // 0 - many identities with possibility to edit all params
357 // 1 - many identities with possibility to edit all params but not email address
358 // 2 - one identity with possibility to edit all params
359 // 3 - one identity with possibility to edit all params but not email address
360 $rcmail_config['identities_level'] = 0;
361
f7b58af @thomascube Make list of mimetypes that open in preview window configurable (#148…
thomascube authored
362 // Mimetypes supported by the browser.
363 // attachments of these types will open in a preview window
364 // either a comma-separated list or an array: 'text/plain,text/html,text/xml,image/jpeg,image/gif,image/png,application/pdf'
365 $rcmail_config['client_mimetypes'] = null; # null == default
366
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
367 // mime magic database
368 $rcmail_config['mime_magic'] = '/usr/share/misc/magic';
369
0501b63 @thomascube Merge branch devel-addressbook (r4193:4382) back into trunk
thomascube authored
370 // path to imagemagick identify binary
371 $rcmail_config['im_identify_path'] = null;
372
373 // path to imagemagick convert binary
374 $rcmail_config['im_convert_path'] = null;
375
376 // maximum size of uploaded contact photos in pixel
377 $rcmail_config['contact_photo_size'] = 160;
378
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
379 // Enable DNS checking for e-mail address validation
380 $rcmail_config['email_dns_check'] = false;
381
382 // ----------------------------------
383 // PLUGINS
384 // ----------------------------------
385
386 // List of active plugins (in plugins/ directory)
387 $rcmail_config['plugins'] = array();
388
389 // ----------------------------------
390 // USER INTERFACE
391 // ----------------------------------
392
f52c936 @thomascube Merged devel-threads branch (r3066:3364) back into trunk
thomascube authored
393 // default messages sort column. Use empty value for default server's sorting,
e0efd8f @alecpl Added separate From and To columns apart from smart From/To column (#…
alecpl authored
394 // or 'arrival', 'date', 'subject', 'from', 'to', 'fromto', 'size', 'cc'
f52c936 @thomascube Merged devel-threads branch (r3066:3364) back into trunk
thomascube authored
395 $rcmail_config['message_sort_col'] = '';
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
396
f52c936 @thomascube Merged devel-threads branch (r3066:3364) back into trunk
thomascube authored
397 // default messages sort order
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
398 $rcmail_config['message_sort_order'] = 'DESC';
399
400 // These cols are shown in the message list. Available cols are:
e0efd8f @alecpl Added separate From and To columns apart from smart From/To column (#…
alecpl authored
401 // subject, from, to, fromto, cc, replyto, date, size, status, flag, attachment, 'priority'
402 $rcmail_config['list_cols'] = array('subject', 'status', 'fromto', 'date', 'size', 'flag', 'attachment');
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
403
c8ae249 @thomascube Auto-detect client language and timezone if desired by config/prefs
thomascube authored
404 // the default locale setting (leave empty for auto-detection)
405 // RFC1766 formatted language name like en_US, de_DE, de_CH, fr_FR, pt_BR
406 $rcmail_config['language'] = null;
4e17e6c @thomascube Initial revision
thomascube authored
407
1cc9e21 @thomascube Make date/time format user configurable; drop 'date_today' config option
thomascube authored
408 // use this format for date display (date or strftime format)
409 $rcmail_config['date_format'] = 'Y-m-d';
4e17e6c @thomascube Initial revision
thomascube authored
410
1cc9e21 @thomascube Make date/time format user configurable; drop 'date_today' config option
thomascube authored
411 // give this choice of date formats to the user to select from
412 $rcmail_config['date_formats'] = array('Y-m-d', 'd-m-Y', 'Y/m/d', 'm/d/Y', 'd/m/Y', 'd.m.Y', 'j.n.Y');
4e17e6c @thomascube Initial revision
thomascube authored
413
1cc9e21 @thomascube Make date/time format user configurable; drop 'date_today' config option
thomascube authored
414 // use this format for time display (date or strftime format)
415 $rcmail_config['time_format'] = 'H:i';
8c8b2a4 Allow 12 hour date to display for emails sent today (Doug Mandell).
svncommit authored
416
1cc9e21 @thomascube Make date/time format user configurable; drop 'date_today' config option
thomascube authored
417 // give this choice of time formats to the user to select from
418 $rcmail_config['time_formats'] = array('G:i', 'H:i', 'g:i a', 'h:i A');
419
420 // use this format for short date display (derived from date_format and time_format)
421 $rcmail_config['date_short'] = 'D H:i';
422
423 // use this format for detailed date/time formatting (derived from date_format and time_format)
424 $rcmail_config['date_long'] = 'Y-m-d H:i';
0501b63 @thomascube Merge branch devel-addressbook (r4193:4382) back into trunk
thomascube authored
425
1966c53 Added Drafts support (Feature #1326839) (richs)
svncommit authored
426 // store draft message is this mailbox
427 // leave blank if draft messages should not be stored
d08333e @alecpl - Fix problems with subfolders of INBOX folder on some IMAP servers (…
alecpl authored
428 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
1966c53 Added Drafts support (Feature #1326839) (richs)
svncommit authored
429 $rcmail_config['drafts_mbox'] = 'Drafts';
430
b4b0817 Workaround for drag-drop using whitespace in FF, Junk emptying, misc …
svncommit authored
431 // store spam messages in this mailbox
d08333e @alecpl - Fix problems with subfolders of INBOX folder on some IMAP servers (…
alecpl authored
432 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
b4b0817 Workaround for drag-drop using whitespace in FF, Junk emptying, misc …
svncommit authored
433 $rcmail_config['junk_mbox'] = 'Junk';
434
4e17e6c @thomascube Initial revision
thomascube authored
435 // store sent message is this mailbox
436 // leave blank if sent messages should not be stored
d08333e @alecpl - Fix problems with subfolders of INBOX folder on some IMAP servers (…
alecpl authored
437 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
4e17e6c @thomascube Initial revision
thomascube authored
438 $rcmail_config['sent_mbox'] = 'Sent';
439
440 // move messages to this folder when deleting them
441 // leave blank if they should be deleted directly
d08333e @alecpl - Fix problems with subfolders of INBOX folder on some IMAP servers (…
alecpl authored
442 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
4e17e6c @thomascube Initial revision
thomascube authored
443 $rcmail_config['trash_mbox'] = 'Trash';
444
fa4cd20 @thomascube Several bugfixes; see CHANGELOG for details
thomascube authored
445 // display these folders separately in the mailbox list.
83ce4bb @thomascube Correct/clarify installation hints
thomascube authored
446 // these folders will also be displayed with localized names
d08333e @alecpl - Fix problems with subfolders of INBOX folder on some IMAP servers (…
alecpl authored
447 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
bf9ddec @alecpl - default_imap_folders -> default_folders
alecpl authored
448 $rcmail_config['default_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash');
4e17e6c @thomascube Initial revision
thomascube authored
449
95ebcd9 @alecpl - Fix description of create_default_folders (#1488183)
alecpl authored
450 // automatically create the above listed default folders on first login
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
451 $rcmail_config['create_default_folders'] = false;
b2ff3d4 @thomascube Don't create default folders by default
thomascube authored
452
c8c1e0e Renameable folders, mail-checking changes, other fixes (richs)
svncommit authored
453 // protect the default folders from renames, deletes, and subscription changes
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
454 $rcmail_config['protect_default_folders'] = true;
c8c1e0e Renameable folders, mail-checking changes, other fixes (richs)
svncommit authored
455
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
456 // if in your system 0 quota means no limit set this option to true
457 $rcmail_config['quota_zero_as_unlimited'] = false;
876b15d @alecpl - Added option 'quota_zero_as_unlimited' (#1484604)
alecpl authored
458
9960666 @thomascube Added support for Nox Spell Server; plus small bugfixes
thomascube authored
459 // Make use of the built-in spell checker. It is based on GoogieSpell.
e9ac143 @thomascube Copy changes from r892 and r903
thomascube authored
460 // Since Google only accepts connections over https your PHP installatation
461 // requires to be compiled with Open SSL support
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
462 $rcmail_config['enable_spellcheck'] = true;
ed5d29f @thomascube Finalized GoogieSpell integration
thomascube authored
463
66df084 @alecpl - Merge devel-spellcheck branch:
alecpl authored
464 // Enables spellchecker exceptions dictionary.
465 // Setting it to 'shared' will make the dictionary shared by all users.
466 $rcmail_config['spellcheck_dictionary'] = false;
467
5d2b7fd @thomascube Added pspell support patch by Kris Steinhoff (#1483960)
thomascube authored
468 // Set the spell checking engine. 'googie' is the default. 'pspell' is also available,
469 // but requires the Pspell extensions. When using Nox Spell Server, also set 'googie' here.
470 $rcmail_config['spellcheck_engine'] = 'googie';
471
9960666 @thomascube Added support for Nox Spell Server; plus small bugfixes
thomascube authored
472 // For a locally installed Nox Spell Server, please specify the URI to call it.
473 // Get Nox Spell Server from http://orangoo.com/labs/?page_id=72
474 // Leave empty to use the Google spell checking service, what means
475 // that the message content will be sent to Google in order to check spelling
476 $rcmail_config['spellcheck_uri'] = '';
477
478 // These languages can be selected for spell checking.
479 // Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch');
01a8c54 @thomascube Applied patch for pspell language configuration (#1485822)
thomascube authored
480 // Leave empty for default set of available language.
9960666 @thomascube Added support for Nox Spell Server; plus small bugfixes
thomascube authored
481 $rcmail_config['spellcheck_languages'] = NULL;
482
66df084 @alecpl - Merge devel-spellcheck branch:
alecpl authored
483 // Makes that words with all letters capitalized will be ignored (e.g. GOOGLE)
484 $rcmail_config['spellcheck_ignore_caps'] = false;
485
486 // Makes that words with numbers will be ignored (e.g. g00gle)
487 $rcmail_config['spellcheck_ignore_nums'] = false;
488
489 // Makes that words with symbols will be ignored (e.g. g@@gle)
490 $rcmail_config['spellcheck_ignore_syms'] = false;
491
62c8618 @thomascube Make email recipients separator configurable + suppress dupes in auto…
thomascube authored
492 // Use this char/string to separate recipients when composing a new message
493 $rcmail_config['recipients_separator'] = ',';
494
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
495 // don't let users set pagesize to more than this value if set
496 $rcmail_config['max_pagesize'] = 200;
967b342 @thomascube Disable installer by default; add config option to enable it again
thomascube authored
497
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
498 // Minimal value of user's 'keep_alive' setting (in seconds)
499 // Must be less than 'session_lifetime'
500 $rcmail_config['min_keep_alive'] = 60;
b076a46 @thomascube Finished message sorting and fixed some skin issues
thomascube authored
501
4171c59 @alecpl - Add optional textual upload progress indicator (#1486039)
alecpl authored
502 // Enables files upload indicator. Requires APC installed and enabled apc.rfc1867 option.
503 // By default refresh time is set to 1 second. You can set this value to true
504 // or any integer value indicating number of seconds.
505 $rcmail_config['upload_progress'] = false;
506
63fda8a @alecpl - Make Undo action optional by setting undo_timeout=0
alecpl authored
507 // Specifies for how many seconds the Undo button will be available
508 // after object delete action. Currently used with supporting address book sources.
509 // Setting it to 0, disables the feature.
510 $rcmail_config['undo_timeout'] = 0;
511
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
512 // ----------------------------------
513 // ADDRESSBOOK SETTINGS
514 // ----------------------------------
aec82bd @till * introduced session_domain
till authored
515
6153e20 @alecpl - Option 'use_SQL_address_book' replaced by 'address_book_type'
alecpl authored
516 // This indicates which type of address book to use. Possible choises:
517 // 'sql' (default) and 'ldap'.
518 // If set to 'ldap' then it will look at using the first writable LDAP
4f9c833 /tmp/out
svncommit authored
519 // address book as the primary address book and it will not display the
520 // SQL address book in the 'Address Book' view.
6153e20 @alecpl - Option 'use_SQL_address_book' replaced by 'address_book_type'
alecpl authored
521 $rcmail_config['address_book_type'] = 'sql';
4f9c833 /tmp/out
svncommit authored
522
523 // In order to enable public ldap search, configure an array like the Verisign
524 // example further below. if you would like to test, simply uncomment the example.
ecf295f @alecpl - Added searching in all addressbook sources (global-search)
alecpl authored
525 // Array key must contain only safe characters, ie. a-zA-Z0-9_
5f25a1a @thomascube Merge ldap_public with autocomplete_addressbooks settings + fix confi…
thomascube authored
526 $rcmail_config['ldap_public'] = array();
527
4f9c833 /tmp/out
svncommit authored
528 // If you are going to use LDAP for individual address books, you will need to
529 // set 'user_specific' to true and use the variables to generate the appropriate DNs to access it.
530 //
531 // The recommended directory structure for LDAP is to store all the address book entries
532 // under the users main entry, e.g.:
533 //
534 // o=root
535 // ou=people
536 // uid=user@domain
3b9a53f @thomascube Make ldap config template easier to uncomment
thomascube authored
537 // mail=contact@contactdomain
538 //
4f9c833 /tmp/out
svncommit authored
539 // So the base_dn would be uid=%fu,ou=people,o=root
540 // The bind_dn would be the same as based_dn or some super user login.
3b9a53f @thomascube Make ldap config template easier to uncomment
thomascube authored
541 /*
f115416 @thomascube Merged branch devel-addressbook from r443 back to trunk
thomascube authored
542 * example config for Verisign directory
eea43f7 better explanation of ldap_public in config file. changed check for l…
svncommit authored
543 *
3b9a53f @thomascube Make ldap config template easier to uncomment
thomascube authored
544 $rcmail_config['ldap_public']['Verisign'] = array(
545 'name' => 'Verisign.com',
bb8721a @alecpl - Support dynamic hostname (%d/%n) variables in configuration options…
alecpl authored
546 // Replacement variables supported in host names:
547 // %h - user's IMAP hostname
d359dcb @bes-internal use in parse_host HTTP_HOST for %d
bes-internal authored
548 // %n - hostname ($_SERVER['SERVER_NAME'])
549 // %t - hostname without the first part
550 // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
11be933 @alecpl - Support %z variable in host configuration options (#1487003)
alecpl authored
551 // %z - IMAP domain (IMAP hostname without the first part)
d359dcb @bes-internal use in parse_host HTTP_HOST for %d
bes-internal authored
552 // For example %n = mail.domain.tld, %t = domain.tld
3b9a53f @thomascube Make ldap config template easier to uncomment
thomascube authored
553 'hosts' => array('directory.verisign.com'),
554 'port' => 389,
1148c6e @alecpl - Add option do bind for an individual LDAP address book (#1486997)
alecpl authored
555 'use_tls' => false,
0c52106 @alecpl - Some cleanup in LDAP config description
alecpl authored
556 'ldap_version' => 3, // using LDAPv3
3b9a53f @thomascube Make ldap config template easier to uncomment
thomascube authored
557 'user_specific' => false, // If true the base_dn, bind_dn and bind_pass default to the user's IMAP login.
558 // %fu - The full username provided, assumes the username is an email
559 // address, uses the username_domain value if not an email address.
560 // %u - The username prior to the '@'.
561 // %d - The domain name after the '@'.
f767654 @alecpl - Add %dc variable support in base_dn/bind_dn config (#1486779)
alecpl authored
562 // %dc - The domain name hierarchal string e.g. "dc=test,dc=domain,dc=com"
1148c6e @alecpl - Add option do bind for an individual LDAP address book (#1486997)
alecpl authored
563 // %dn - DN found by ldap search when search_filter/search_base_dn are used
3b9a53f @thomascube Make ldap config template easier to uncomment
thomascube authored
564 'base_dn' => '',
565 'bind_dn' => '',
566 'bind_pass' => '',
1148c6e @alecpl - Add option do bind for an individual LDAP address book (#1486997)
alecpl authored
567 // It's possible to bind for an individual address book
568 // The login name is used to search for the DN to bind with
569 'search_base_dn' => '',
570 'search_filter' => '', // e.g. '(&(objectClass=posixAccount)(uid=%u))'
2d08ec9 @alecpl - Add possibility to do LDAP bind before searching for bind DN.
alecpl authored
571 // DN and password to bind as before searching for bind DN, if anonymous search is not allowed
572 'search_bind_dn' => '',
573 'search_bind_pw' => '',
c041d57 @alecpl - Added 'search_dn_default' variable in ldap config
alecpl authored
574 // Default for %dn variable if search doesn't return DN value
575 'search_dn_default' => '',
4d982d3 @alecpl - Add LDAP SASL bind and proxy authentication (#1486692)
alecpl authored
576 // Optional authentication identifier to be used as SASL authorization proxy
577 // bind_dn need to be empty
578 'auth_cid' => '',
579 // SASL authentication method (for proxy auth), e.g. DIGEST-MD5
580 'auth_method' => '',
2d3e2bc @thomascube Add option 'searchonly' for address books; currently used by LDAP dir…
thomascube authored
581 // Indicates if the addressbook shall be hidden from the list.
5c9d1ff @alecpl - Add option to hide selected LDAP addressbook on the list
alecpl authored
582 // With this option enabled you can still search/view contacts.
583 'hidden' => false,
2d3e2bc @thomascube Add option 'searchonly' for address books; currently used by LDAP dir…
thomascube authored
584 // Indicates if the addressbook shall not list contacts but only allows searching.
585 'searchonly' => false,
0c52106 @alecpl - Some cleanup in LDAP config description
alecpl authored
586 // Indicates if we can write to the LDAP directory or not.
3b9a53f @thomascube Make ldap config template easier to uncomment
thomascube authored
587 // If writable is true then these fields need to be populated:
588 // LDAP_Object_Classes, required_fields, LDAP_rdn
0c52106 @alecpl - Some cleanup in LDAP config description
alecpl authored
589 'writable' => false,
590 // To create a new contact these are the object classes to specify
591 // (or any other classes you wish to use).
592 'LDAP_Object_Classes' => array('top', 'inetOrgPerson'),
593 // The RDN field that is used for new entries, this field needs
594 // to be one of the search_fields, the base of base_dn is appended
595 // to the RDN to insert into the LDAP directory.
ca3d76d @alecpl - More LDAP fields mapping (inetOrgPerson)
alecpl authored
596 'LDAP_rdn' => 'cn',
0c52106 @alecpl - Some cleanup in LDAP config description
alecpl authored
597 // The required fields needed to build a new contact as required by
598 // the object classes (can include additional fields not required by the object classes).
599 'required_fields' => array('cn', 'sn', 'mail'),
600 'search_fields' => array('mail', 'cn'), // fields to search in
601 // mapping of contact fields to directory attributes
a605b25 @thomascube - Allow to configure the number of values allowed for each LDAP attri…
thomascube authored
602 // for every attribute one can specify the number of values (limit) allowed.
603 // default is 1, a wildcard * means unlimited
0c52106 @alecpl - Some cleanup in LDAP config description
alecpl authored
604 'fieldmap' => array(
a605b25 @thomascube - Allow to configure the number of values allowed for each LDAP attri…
thomascube authored
605 // Roundcube => LDAP:limit
0501b63 @thomascube Merge branch devel-addressbook (r4193:4382) back into trunk
thomascube authored
606 'name' => 'cn',
607 'surname' => 'sn',
608 'firstname' => 'givenName',
b2c3c31 @alecpl Use correct field name (title -> jobtitle) in example LDAP addressboo…
alecpl authored
609 'jobtitle' => 'title',
a605b25 @thomascube - Allow to configure the number of values allowed for each LDAP attri…
thomascube authored
610 'email' => 'mail:*',
0501b63 @thomascube Merge branch devel-addressbook (r4193:4382) back into trunk
thomascube authored
611 'phone:home' => 'homePhone',
612 'phone:work' => 'telephoneNumber',
613 'phone:mobile' => 'mobile',
ca3d76d @alecpl - More LDAP fields mapping (inetOrgPerson)
alecpl authored
614 'phone:pager' => 'pager',
0501b63 @thomascube Merge branch devel-addressbook (r4193:4382) back into trunk
thomascube authored
615 'street' => 'street',
616 'zipcode' => 'postalCode',
ca3d76d @alecpl - More LDAP fields mapping (inetOrgPerson)
alecpl authored
617 'region' => 'st',
0501b63 @thomascube Merge branch devel-addressbook (r4193:4382) back into trunk
thomascube authored
618 'locality' => 'l',
a605b25 @thomascube - Allow to configure the number of values allowed for each LDAP attri…
thomascube authored
619 // if you country is a complex object, you need to configure 'sub_fields' below
620 'country' => 'c',
b563fc8 @alecpl - Uncomment 'organization'=>'o' - it works
alecpl authored
621 'organization' => 'o',
a605b25 @thomascube - Allow to configure the number of values allowed for each LDAP attri…
thomascube authored
622 'department' => 'ou',
623 'jobtitle' => 'title',
624 'notes' => 'description',
625 // these currently don't work:
626 // 'phone:workfax' => 'facsimileTelephoneNumber',
627 // 'photo' => 'jpegPhoto',
628 // 'manager' => 'manager',
629 // 'assistant' => 'secretary',
0501b63 @thomascube Merge branch devel-addressbook (r4193:4382) back into trunk
thomascube authored
630 ),
a605b25 @thomascube - Allow to configure the number of values allowed for each LDAP attri…
thomascube authored
631 // Map of contact sub-objects (attribute name => objectClass(es)), e.g. 'c' => 'country'
632 'sub_fields' => array(),
3b9a53f @thomascube Make ldap config template easier to uncomment
thomascube authored
633 'sort' => 'cn', // The field to sort the listing by.
634 'scope' => 'sub', // search mode: sub|base|list
d1e08fc @thomascube Replace LDAP vars in group queries (#1487837)
thomascube authored
635 'filter' => '(objectClass=inetOrgPerson)', // used for basic listing (if not empty) and will be &'d with search queries. example: status=act
6506010 @alecpl - Fix parse error after uncommenting default ldap_public settings (#1…
alecpl authored
636 'fuzzy_search' => true, // server allows wildcard search
15d7627 @thomascube Fix typos
thomascube authored
637 'vlv' => false, // Enable Virtual List View to more efficiently fetch paginated data (if server supports it)
6af7e0d @thomascube Use numSubOrdindates inconjuction with VLV to count total
thomascube authored
638 'numsub_filter' => '(objectClass=organizationalUnit)', // with VLV, we also use numSubOrdinates to query the total number of records. Set this filter to get all numSubOrdinates attributes for counting
6039aae @thomascube Add groups support for LDAP address books, contributed by Andreas Dick
thomascube authored
639 'sizelimit' => '0', // Enables you to limit the count of entries fetched. Setting this to 0 means no limit.
640 'timelimit' => '0', // Sets the number of seconds how long is spend on the search. Setting this to 0 means no limit.
3b4b03d @thomascube Added config property to set LDAP_OPT_REFERRALS option to an LDAP con…
thomascube authored
641 'referrals' => true|false, // Sets the LDAP_OPT_REFERRALS option. Mostly used in multi-domain Active Directory setups
d1e08fc @thomascube Replace LDAP vars in group queries (#1487837)
thomascube authored
642
643 // definition for contact groups (uncomment if no groups are supported)
644 // for the groups base_dn, the user replacements %fu, %u, $d and %dc work as for base_dn (see above)
645 // if the groups base_dn is empty, the contact base_dn is used for the groups as well
15d7627 @thomascube Fix typos
thomascube authored
646 // -> in this case, assure that groups and contacts are separated due to the concernig filters!
6039aae @thomascube Add groups support for LDAP address books, contributed by Andreas Dick
thomascube authored
647 'groups' => array(
f763fbd @alecpl - Make group's "member" attibute name configurable
alecpl authored
648 'base_dn' => '',
aa9ddf1 @thomascube Describe 'scope' option for LDAP groups in config template
thomascube authored
649 'scope' => 'sub', // search mode: sub|base|list
6039aae @thomascube Add groups support for LDAP address books, contributed by Andreas Dick
thomascube authored
650 'filter' => '(objectClass=groupOfNames)',
d1e08fc @thomascube Replace LDAP vars in group queries (#1487837)
thomascube authored
651 'object_classes' => array("top", "groupOfNames"),
ad27eb2 @thomascube Describe new name attribute for LDAP groups
thomascube authored
652 'member_attr' => 'member', // name of the member attribute, e.g. uniqueMember
653 'name_attr' => 'cn', // attribute to be used as group name
6039aae @thomascube Add groups support for LDAP address books, contributed by Andreas Dick
thomascube authored
654 ),
93c0188 @alecpl - Add sizelimit and timelimit variables in LDAP config (#1486544)
alecpl authored
655 );
3b9a53f @thomascube Make ldap config template easier to uncomment
thomascube authored
656 */
d1d2c4f adding files and modifications for public ldap search
svncommit authored
657
2c8e84c @thomascube Do serverside addressbook queries for autocompletion (#1485531) + mak…
thomascube authored
658 // An ordered array of the ids of the addressbooks that should be searched
659 // when populating address autocomplete fields server-side. ex: array('sql','Verisign');
660 $rcmail_config['autocomplete_addressbooks'] = array('sql');
661
c296b81 @alecpl - Add option for minimum length of autocomplete's string (#1486428)
alecpl authored
662 // The minimum number of characters required to be typed in an autocomplete field
663 // before address books will be searched. Most useful for LDAP directories that
664 // may need to do lengthy results building given overly-broad searches
665 $rcmail_config['autocomplete_min_length'] = 1;
666
0213f8d @alecpl - Added optional "multithreading" autocomplete feature
alecpl authored
667 // Number of parallel autocomplete requests.
668 // If there's more than one address book, n parallel (async) requests will be created,
669 // where each request will search in one address book. By default (0), all address
670 // books are searched in one request.
671 $rcmail_config['autocomplete_threads'] = 0;
672
673 // Max. numer of entries in autocomplete popup. Default: 15.
674 $rcmail_config['autocomplete_max'] = 15;
675
0501b63 @thomascube Merge branch devel-addressbook (r4193:4382) back into trunk
thomascube authored
676 // show address fields in this order
677 // available placeholders: {street}, {locality}, {zipcode}, {country}, {region}
678 $rcmail_config['address_template'] = '{street}<br/>{locality} {zipcode}<br/>{country} {region}';
679
f21a04c @alecpl - Add option to define matching method for addressbook search (#14865…
alecpl authored
680 // Matching mode for addressbook search (including autocompletion)
681 // 0 - partial (*abc*), default
682 // 1 - strict (abc)
683 // 2 - prefix (abc*)
684 // Note: For LDAP sources fuzzy_search must be enabled to use 'partial' or 'prefix' mode
685 $rcmail_config['addressbook_search_mode'] = 0;
686
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
687 // ----------------------------------
688 // USER PREFERENCES
689 // ----------------------------------
4e17e6c @thomascube Initial revision
thomascube authored
690
e55ab02 @alecpl - Add 'default_charset' option to user preferences (#1485451)
alecpl authored
691 // Use this charset as fallback for message decoding
692 $rcmail_config['default_charset'] = 'ISO-8859-1';
693
67effe9 @alecpl - actually we don't need default_skin option
alecpl authored
694 // skin name: folder from skins/
9f1652e @thomascube Adapt to new default skin folder namimg
thomascube authored
695 $rcmail_config['skin'] = 'larry';
e58df3a @alecpl - Added option to select skin in user preferences (#1485031)
alecpl authored
696
08ffd93 @alecpl - Add separate pagesize setting for mail messages and contacts (#1488…
alecpl authored
697 // show up to X items in messages list view
698 $rcmail_config['mail_pagesize'] = 50;
699
700 // show up to X items in contacts list view
701 $rcmail_config['addressbook_pagesize'] = 50;
4e17e6c @thomascube Initial revision
thomascube authored
702
4387537 @thomascube Allow users to choose cols for contacts list sorting
thomascube authored
703 // sort contacts by this col (preferably either one of name, firstname, surname)
704 $rcmail_config['addressbook_sort_col'] = 'surname';
705
f9a9677 @thomascube User configurable setting how to display contact names in list
thomascube authored
706 // the way how contact names are displayed in the list
707 // 0: display name
708 // 1: (prefix) firstname middlename surname (suffix)
709 // 2: (prefix) surname firstname middlename (suffix)
710 // 3: (prefix) surname, firstname middlename (suffix)
711 $rcmail_config['addressbook_name_listing'] = 0;
712
4e17e6c @thomascube Initial revision
thomascube authored
713 // use this timezone to display date/time
5879c09 @thomascube Use proper timezones from PHP's internal timezonedb (#1485592)
thomascube authored
714 // valid timezone identifers are listed here: php.net/manual/en/timezones.php
715 // 'auto' will use the browser's timezone settings
c8ae249 @thomascube Auto-detect client language and timezone if desired by config/prefs
thomascube authored
716 $rcmail_config['timezone'] = 'auto';
4e17e6c @thomascube Initial revision
thomascube authored
717
718 // prefer displaying HTML messages
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
719 $rcmail_config['prefer_html'] = true;
4e17e6c @thomascube Initial revision
thomascube authored
720
2a41355 @alecpl - Added 'show_images' option, removed 'addrbook_show_images' (#1485597)
alecpl authored
721 // display remote inline images
722 // 0 - Never, always ask
723 // 1 - Ask if sender is not in address book
724 // 2 - Always show inline images
725 $rcmail_config['show_images'] = 0;
712b30d @alecpl - Added option to display images in messages from known senders (#148…
alecpl authored
726
b190970 @thomascube Introducing preview pane and conditional skin tags
thomascube authored
727 // compose html formatted messages by default
8eefbb2 @alecpl Add option to enable HTML editor on forwarding (#1488517)
alecpl authored
728 // 0 - never, 1 - always, 2 - on reply to HTML message, 3 - on forward or reply to HTML message
868deb5 @alecpl - Make htmleditor option behaviour consistent, add option to use HTML…
alecpl authored
729 $rcmail_config['htmleditor'] = 0;
b190970 @thomascube Introducing preview pane and conditional skin tags
thomascube authored
730
30233b8 @thomascube Minor bugfixes and correction of confusing License notfications
thomascube authored
731 // show pretty dates as standard
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
732 $rcmail_config['prettydate'] = true;
30233b8 @thomascube Minor bugfixes and correction of confusing License notfications
thomascube authored
733
d656f1c @thomascube Made automatic draft saving configurable
thomascube authored
734 // save compose message every 300 seconds (5min)
735 $rcmail_config['draft_autosave'] = 300;
0566adc @thomascube Include host-specific configuration file
thomascube authored
736
b190970 @thomascube Introducing preview pane and conditional skin tags
thomascube authored
737 // default setting if preview pane is enabled
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
738 $rcmail_config['preview_pane'] = false;
b190970 @thomascube Introducing preview pane and conditional skin tags
thomascube authored
739
bc49601 @thomascube Option not to mark messages as read when viewed in preview pane (#148…
thomascube authored
740 // Mark as read when viewed in preview pane (delay in seconds)
741 // Set to -1 if messages in preview pane should not be marked as read
742 $rcmail_config['preview_pane_mark_read'] = 0;
743
eaa3947 @alecpl #1483863: empty trash and expunge inbox on logout
alecpl authored
744 // Clear Trash on logout
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
745 $rcmail_config['logout_purge'] = false;
eaa3947 @alecpl #1483863: empty trash and expunge inbox on logout
alecpl authored
746
747 // Compact INBOX on logout
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
748 $rcmail_config['logout_expunge'] = false;
eaa3947 @alecpl #1483863: empty trash and expunge inbox on logout
alecpl authored
749
166b615 @alecpl - Added option to disable displaying of attached images below the mes…
alecpl authored
750 // Display attached images below the message body
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
751 $rcmail_config['inline_images'] = true;
5e0045b Add option to log successful logins.
svncommit authored
752
ffae15e @alecpl - Added 'mime_param_folding' option with possibility to choose
alecpl authored
753 // Encoding of long/non-ascii attachment names:
754 // 0 - Full RFC 2231 compatible
755 // 1 - RFC 2047 for 'name' and RFC 2231 for 'filename' parameter (Thunderbird's default)
756 // 2 - Full 2047 compatible
21c277e @alecpl - set mime_param_folding to '1' by default
alecpl authored
757 $rcmail_config['mime_param_folding'] = 1;
ffae15e @alecpl - Added 'mime_param_folding' option with possibility to choose
alecpl authored
758
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
759 // Set true if deleted messages should not be displayed
2b58528 @alecpl - some option moved to user prefs section
alecpl authored
760 // This will make the application run slower
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
761 $rcmail_config['skip_deleted'] = false;
2b58528 @alecpl - some option moved to user prefs section
alecpl authored
762
763 // Set true to Mark deleted messages as read as well as deleted
764 // False means that a message's read status is not affected by marking it as deleted
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
765 $rcmail_config['read_when_deleted'] = true;
2b58528 @alecpl - some option moved to user prefs section
alecpl authored
766
ca8a178 @alecpl - Fix typo in comment
alecpl authored
767 // Set to true to never delete messages immediately
768 // Use 'Purge' to remove messages marked as deleted
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
769 $rcmail_config['flag_for_deletion'] = false;
2b58528 @alecpl - some option moved to user prefs section
alecpl authored
770
95d90f8 @alecpl - Added 'keep_alive' and 'min_keep_alive' options (#1485360)
alecpl authored
771 // Default interval for keep-alive/check-recent requests (in seconds)
772 // Must be greater than or equal to 'min_keep_alive' and less than 'session_lifetime'
773 $rcmail_config['keep_alive'] = 60;
774
2fd9750 @thomascube Option to check for new mails in all folders (#1484374)
thomascube authored
775 // If true all folders will be checked for recent messages
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
776 $rcmail_config['check_all_folders'] = false;
2fd9750 @thomascube Option to check for new mails in all folders (#1484374)
thomascube authored
777
e54bb72 @alecpl - Added 'display_next' option
alecpl authored
778 // If true, after message delete/move, the next message will be displayed
b1f30d8 @thomascube Set display_next option to true by default (in config template)
thomascube authored
779 $rcmail_config['display_next'] = true;
e54bb72 @alecpl - Added 'display_next' option
alecpl authored
780
f52c936 @thomascube Merged devel-threads branch (r3066:3364) back into trunk
thomascube authored
781 // 0 - Do not expand threads
782 // 1 - Expand all threads automatically
783 // 2 - Expand only threads with unread messages
784 $rcmail_config['autoexpand_threads'] = 0;
1cead0c @alecpl - sorting by message index - added 'index_sort' option (#1485936)
alecpl authored
785
651c7b6 @alecpl Add option to not include original message on reply, rename option to…
alecpl authored
786 // When replying:
787 // -1 - don't cite the original message
788 // 0 - place cursor below the original message
789 // 1 - place cursor above original message (top posting)
790 $rcmail_config['reply_mode'] = 0;
50f56d2 @alecpl - top posting (#1484272)
alecpl authored
791
0207c45 @thomascube More options for top posting feature (#1484272) using patch from Phil…
thomascube authored
792 // When replying strip original signature from message
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
793 $rcmail_config['strip_existing_sig'] = true;
0207c45 @thomascube More options for top posting feature (#1484272) using patch from Phil…
thomascube authored
794
50f56d2 @alecpl - top posting (#1484272)
alecpl authored
795 // Show signature:
0207c45 @thomascube More options for top posting feature (#1484272) using patch from Phil…
thomascube authored
796 // 0 - Never
797 // 1 - Always
50f56d2 @alecpl - top posting (#1484272)
alecpl authored
798 // 2 - New messages only
0207c45 @thomascube More options for top posting feature (#1484272) using patch from Phil…
thomascube authored
799 // 3 - Forwards and Replies only
800 $rcmail_config['show_sig'] = 1;
801
802 // When replying or forwarding place sender's signature above existing message
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
803 $rcmail_config['sig_above'] = false;
50f56d2 @alecpl - top posting (#1484272)
alecpl authored
804
47ad83f @alecpl - Added force_7bit option to force MIME encoding of plain/text messag…
alecpl authored
805 // Use MIME encoding (quoted-printable) for 8bit characters in message body
2d08c50 @alecpl - Support/Require tls:// prefix in 'smtp_server' option for TLS conne…
alecpl authored
806 $rcmail_config['force_7bit'] = false;
47ad83f @alecpl - Added force_7bit option to force MIME encoding of plain/text messag…
alecpl authored
807
b975da2 @thomascube Allow admins to define defaults for search modifiers (#1485897)
thomascube authored
808 // Defaults of the search field configuration.
809 // The array can contain a per-folder list of header fields which should be considered when searching
810 // The entry with key '*' stands for all folders which do not have a specific list set.
bf9ddec @alecpl - default_imap_folders -> default_folders
alecpl authored
811 // Please note that folder names should to be in sync with $rcmail_config['default_folders']
b975da2 @thomascube Allow admins to define defaults for search modifiers (#1485897)
thomascube authored
812 $rcmail_config['search_mods'] = null; // Example: array('*' => array('subject'=>1, 'from'=>1), 'Sent' => array('subject'=>1, 'to'=>1));
813
3cacf94 @alecpl - Add popup with basic fields selection for addressbook search
alecpl authored
814 // Defaults of the addressbook search field configuration.
815 $rcmail_config['addressbook_search_mods'] = null; // Example: array('name'=>1, 'firstname'=>1, 'surname'=>1, 'email'=>1, '*'=>1);
816
b7f9522 @alecpl - Add 'delete_always' option to user preferences
alecpl authored
817 // 'Delete always'
818 // This setting reflects if mail should be always deleted
819 // when moving to Trash fails. This is necessary in some setups
820 // when user is over quota and Trash is included in the quota.
821 $rcmail_config['delete_always'] = false;
822
1b30a71 @alecpl - Add option to delete messages instead of moving to Trash when in Ju…
alecpl authored
823 // Directly delete messages in Junk instead of moving to Trash
824 $rcmail_config['delete_junk'] = false;
825
f22ea7b @alecpl - Support SMTP Delivery Status Notifications - RFC3461 (#1486142)
alecpl authored
826 // Behavior if a received message requests a message delivery notification (read receipt)
827 // 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask)
828 // 3 = send automatically if sender is in addressbook, otherwise ask the user
829 // 4 = send automatically if sender is in addressbook, otherwise ignore
830 $rcmail_config['mdn_requests'] = 0;
b25dfd0 @alecpl - removed PHP closing tag
alecpl authored
831
f22ea7b @alecpl - Support SMTP Delivery Status Notifications - RFC3461 (#1486142)
alecpl authored
832 // Return receipt checkbox default state
833 $rcmail_config['mdn_default'] = 0;
834
835 // Delivery Status Notification checkbox default state
836 $rcmail_config['dsn_default'] = 0;
837
eeb85f4 @alecpl - Add option to place replies in the folder of the message being repl…
alecpl authored
838 // Place replies in the folder of the message being replied to
839 $rcmail_config['reply_same_folder'] = false;
840
a509bb6 @alecpl - Add option to set default action of Forward button to "Forward as a…
alecpl authored
841 // Sets default mode of Forward feature to "forward as attachment"
842 $rcmail_config['forward_attachment'] = false;
843
d734481 @alecpl - Added option to specify to which address book add new contacts
alecpl authored
844 // Defines address book (internal index) to which new contacts will be added
845 // By default it is the first writeable addressbook.
846 // Note: Use '0' for built-in address book.
847 $rcmail_config['default_addressbook'] = null;
848
1d5779b @alecpl - Add option to force spellchecking before sending a message (#1485458)
alecpl authored
849 // Enables spell checking before sending a message.
850 $rcmail_config['spellcheck_before_send'] = false;
851
710b1bd @alecpl - Add option to skip alternative email addresses in autocompletion
alecpl authored
852 // Skip alternative email addresses in autocompletion (show one address per contact)
853 $rcmail_config['autocomplete_single'] = false;
854
7e263ea @alecpl - Add option to set default font for HTML message (#1484137)
alecpl authored
855 // Default font for composed HTML message.
856 // Supported values: Andale Mono, Arial, Arial Black, Book Antiqua, Courier New,
857 // Georgia, Helvetica, Impact, Tahoma, Terminal, Times New Roman, Trebuchet MS, Verdana
858 $rcmail_config['default_font'] = '';
859
f22ea7b @alecpl - Support SMTP Delivery Status Notifications - RFC3461 (#1486142)
alecpl authored
860 // end of config file
Something went wrong with that request. Please try again.