Aleksander Machniak
2016-05-20 ea73d58913874e6dab2345910cc51879a32a71bf
commit | author | age
4e17e6 1 <?php
T 2
3 /*
4  +-----------------------------------------------------------------------+
acc005 5  | Main configuration file with default settings                         |
4e17e6 6  |                                                                       |
e019f2 7  | This file is part of the Roundcube Webmail client                     |
acc005 8  | Copyright (C) 2005-2013, The Roundcube Dev Team                       |
7fe381 9  |                                                                       |
T 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.                     |
4e17e6 13  +-----------------------------------------------------------------------+
T 14 */
15
acc005 16 $config = array();
AM 17
18 // ----------------------------------
19 // SQL DATABASE
20 // ----------------------------------
21
22 // Database connection string (DSN) for read+write operations
23 // Format (compatible with PEAR MDB2): db_provider://user:password@host/database
90c82e 24 // Currently supported db_providers: mysql, pgsql, sqlite, mssql, sqlsrv, oracle
acc005 25 // For examples see http://pear.php.net/manual/en/package.database.mdb2.intro-dsn.php
90c82e 26 // NOTE: for SQLite use absolute path (Linux): 'sqlite:////full/path/to/sqlite.db?mode=0646'
AM 27 //       or (Windows): 'sqlite:///C:/full/path/to/sqlite.db'
9bacb2 28 $config['db_dsnw'] = 'mysql://roundcube:@localhost/roundcubemail';
acc005 29
AM 30 // Database DSN for read-only operations (if empty write database will be used)
31 // useful for database replication
32 $config['db_dsnr'] = '';
33
92d18c 34 // Disable the use of already established dsnw connections for subsequent reads
TB 35 $config['db_dsnw_noread'] = false;
36
acc005 37 // use persistent db-connections
AM 38 // beware this will not "always" work as expected
39 // see: http://www.php.net/manual/en/features.persistent-connections.php
40 $config['db_persistent'] = false;
41
42 // you can define specific table (and sequence) names prefix
43 $config['db_prefix'] = '';
44
a69f99 45 // Mapping of table names and connections to use for ALL operations.
TB 46 // This can be used in a setup with replicated databases and a DB master
47 // where read/write access to cache tables should not go to master.
48 $config['db_table_dsn'] = array(
49 //    'cache' => 'r',
50 //    'cache_index' => 'r',
51 //    'cache_thread' => 'r',
52 //    'cache_messages' => 'r',
53 );
54
8f4854 55 // It is possible to specify database variable values e.g. some limits here.
AM 56 // Use them if your server is not MySQL or for better performance.
57 // For example Roundcube uses max_allowed_packet value (in bytes)
58 // which limits query size for database cache operations.
2a31f6 59 $config['db_max_allowed_packet'] = null;
8f4854 60
4e17e6 61
2d08c5 62 // ----------------------------------
A 63 // LOGGING/DEBUGGING
64 // ----------------------------------
65
5be6dc 66 // system error reporting, sum of: 1 = log; 4 = show
acc005 67 $config['debug_level'] = 1;
4e17e6 68
b77d0d 69 // log driver:  'syslog' or 'file'.
acc005 70 $config['log_driver'] = 'file';
b77d0d 71
0ad27c 72 // date format for log entries
A 73 // (read http://php.net/manual/en/function.date.php for all format characters)  
acc005 74 $config['log_date_format'] = 'd-M-Y H:i:s O';
0ad27c 75
561f5e 76 // length of the session ID to prepend each log line with
TB 77 // set to 0 to avoid session IDs being logged.
78 $config['log_session_id'] = 8;
79
b77d0d 80 // Syslog ident string to use, if using the 'syslog' log driver.
acc005 81 $config['syslog_id'] = 'roundcube';
b77d0d 82
A 83 // Syslog facility to use, if using the 'syslog' log driver.
84 // For possible values see installer or http://php.net/manual/en/function.openlog.php
acc005 85 $config['syslog_facility'] = LOG_USER;
b77d0d 86
3786a4 87 // Activate this option if logs should be written to per-user directories.
TB 88 // Data will only be logged if a directry <log_dir>/<username>/ exists and is writable.
89 $config['per_user_logging'] = false;
90
3e3429 91 // Log sent messages to <log_dir>/sendmail or to syslog
acc005 92 $config['smtp_log'] = true;
b77d0d 93
060467 94 // Log successful/failed logins to <log_dir>/userlogins or to syslog
acc005 95 $config['log_logins'] = false;
b77d0d 96
fcc7f8 97 // Log session authentication errors to <log_dir>/session or to syslog
acc005 98 $config['log_session'] = false;
fcc7f8 99
2d08c5 100 // Log SQL queries to <log_dir>/sql or to syslog
acc005 101 $config['sql_debug'] = false;
cc97ea 102
2d08c5 103 // Log IMAP conversation to <log_dir>/imap or to syslog
acc005 104 $config['imap_debug'] = false;
6dc026 105
2d08c5 106 // Log LDAP conversation to <log_dir>/ldap or to syslog
acc005 107 $config['ldap_debug'] = false;
cc9570 108
2d08c5 109 // Log SMTP conversation to <log_dir>/smtp or to syslog
acc005 110 $config['smtp_debug'] = false;
f5d61d 111
44708e 112 // Log Memcache conversation to <log_dir>/memcache or to syslog
AM 113 $config['memcache_debug'] = false;
114
115 // Log APC conversation to <log_dir>/apc or to syslog
116 $config['apc_debug'] = false;
117
118
2d08c5 119 // ----------------------------------
A 120 // IMAP
121 // ----------------------------------
4e17e6 122
768e33 123 // The mail host chosen to perform the log-in.
AM 124 // Leave blank to show a textbox at login, give a list of hosts
42b113 125 // to display a pulldown menu or set one host as string.
f86e8f 126 // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
bb8721 127 // Supported replacement variables:
d359dc 128 // %n - hostname ($_SERVER['SERVER_NAME'])
B 129 // %t - hostname without the first part
130 // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
b04c51 131 // %s - domain name after the '@' from e-mail address provided at login screen
d359dc 132 // For example %n = mail.domain.tld, %t = domain.tld
768e33 133 // WARNING: After hostname change update of mail_host column in users table is
AM 134 //          required to match old user data records with the new host.
9bacb2 135 $config['default_host'] = 'localhost';
4e17e6 136
42b113 137 // TCP port used for IMAP connections
acc005 138 $config['default_port'] = 143;
42b113 139
00f347 140 // IMAP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or null to use
4dd417 141 // best server supported one)
acc005 142 $config['imap_auth_type'] = null;
b026c3 143
109bcc 144 // IMAP socket context options
AM 145 // See http://php.net/manual/en/context.ssl.php
146 // The example below enables server certificate validation
147 //$config['imap_conn_options'] = array(
148 //  'ssl'         => array(
149 //     'verify_peer'  => true,
150 //     'verify_depth' => 3,
151 //     'cafile'       => '/etc/openssl/certs/ca.crt',
152 //   ),
153 // );
154 $config['imap_conn_options'] = null;
155
156 // IMAP connection timeout, in seconds. Default: 0 (use default_socket_timeout)
157 $config['imap_timeout'] = 0;
158
159 // Optional IMAP authentication identifier to be used as authorization proxy
160 $config['imap_auth_cid'] = null;
161
162 // Optional IMAP authentication password to be used for imap_auth_cid
163 $config['imap_auth_pw'] = null;
164
00290a 165 // If you know your imap's folder delimiter, you can specify it here.
A 166 // Otherwise it will be determined automatically
acc005 167 $config['imap_delimiter'] = null;
030c84 168
5eb9c7 169 // If you know your imap's folder vendor, you can specify it here.
AM 170 // Otherwise it will be determined automatically. Use lower-case
171 // identifiers, e.g. 'dovecot', 'cyrus', 'gmail', 'hmail', 'uw-imap'.
172 $config['imap_vendor'] = null;
173
00290a 174 // If IMAP server doesn't support NAMESPACE extension, but you're
A 175 // using shared folders or personal root folder is non-empty, you'll need to
176 // set these options. All can be strings or arrays of strings.
e3af1f 177 // Folders need to be ended with directory separator, e.g. "INBOX."
A 178 // (special directory "~" is an exception to this rule)
02491a 179 // These can be used also to overwrite server's namespaces
acc005 180 $config['imap_ns_personal'] = null;
AM 181 $config['imap_ns_other']    = null;
182 $config['imap_ns_shared']   = null;
00290a 183
d8c440 184 // By default IMAP capabilities are readed after connection to IMAP server
A 185 // In some cases, e.g. when using IMAP proxy, there's a need to refresh the list
186 // after login. Set to True if you've got this case.
acc005 187 $config['imap_force_caps'] = false;
d8c440 188
f75f65 189 // By default list of subscribed folders is determined using LIST-EXTENDED
A 190 // extension if available. Some servers (dovecot 1.x) returns wrong results
191 // for shared namespaces in this case. http://trac.roundcube.net/ticket/1486225
192 // Enable this option to force LSUB command usage instead.
ed3e51 193 // Deprecated: Use imap_disabled_caps = array('LIST-EXTENDED')
acc005 194 $config['imap_force_lsub'] = false;
f75f65 195
3c5489 196 // Some server configurations (e.g. Courier) doesn't list folders in all namespaces
AM 197 // Enable this option to force listing of folders in all namespaces
acc005 198 $config['imap_force_ns'] = false;
3c5489 199
4ceff8 200 // Some servers return hidden folders (name starting witha dot)
AM 201 // from user home directory. IMAP RFC does not forbid that.
202 // Enable this option to hide them and disable possibility to create such.
203 $config['imap_skip_hidden_folders'] = false;
204
ed3e51 205 // List of disabled imap extensions.
AM 206 // Use if your IMAP server has broken implementation of some feature
207 // and you can't remove it from CAPABILITY string on server-side.
208 // For example UW-IMAP server has broken ESEARCH.
209 // Note: Because the list is cached, re-login is required after change.
7c6848 210 $config['imap_disabled_caps'] = array();
a1fe6b 211
561f5e 212 // Log IMAP session identifers after each IMAP login.
TB 213 // This is used to relate IMAP session with Roundcube user sessions
214 $config['imap_log_session'] = false;
215
8edb3d 216 // Type of IMAP indexes cache. Supported values: 'db', 'apc' and 'memcache'.
acc005 217 $config['imap_cache'] = null;
5cf5ee 218
A 219 // Enables messages cache. Only 'db' cache is supported.
769829 220 // This requires an IMAP server that supports QRESYNC and CONDSTORE
AM 221 // extensions (RFC7162). See synchronize() in program/lib/Roundcube/rcube_imap_cache.php
222 // for further info, or if you experience syncing problems.
acc005 223 $config['messages_cache'] = false;
5cf5ee 224
61ccdf 225 // Lifetime of IMAP indexes cache. Possible units: s, m, h, d, w
acc005 226 $config['imap_cache_ttl'] = '10d';
61ccdf 227
67ac6e 228 // Lifetime of messages cache. Possible units: s, m, h, d, w
acc005 229 $config['messages_cache_ttl'] = '10d';
5cf5ee 230
21601b 231 // Maximum cached message size in kilobytes.
AM 232 // Note: On MySQL this should be less than (max_allowed_packet - 30%)
233 $config['messages_cache_threshold'] = 50;
234
235
2d08c5 236 // ----------------------------------
A 237 // SMTP
238 // ----------------------------------
f88d41 239
c3b676 240 // SMTP server host (for sending mails).
2d08c5 241 // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
c3b676 242 // If left blank, the PHP mail() function is used
bb8721 243 // Supported replacement variables:
A 244 // %h - user's IMAP hostname
d359dc 245 // %n - hostname ($_SERVER['SERVER_NAME'])
B 246 // %t - hostname without the first part
247 // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
11be93 248 // %z - IMAP domain (IMAP hostname without the first part)
d359dc 249 // For example %n = mail.domain.tld, %t = domain.tld
acc005 250 $config['smtp_server'] = '';
4e17e6 251
e52aae 252 // SMTP port (default is 25; use 587 for STARTTLS or 465 for the
T 253 // deprecated SSL over SMTP (aka SMTPS))
acc005 254 $config['smtp_port'] = 25;
968bdc 255
e019f2 256 // SMTP username (if required) if you use %u as the username Roundcube
d206c1 257 // will use the current username for login
acc005 258 $config['smtp_user'] = '';
4e17e6 259
e019f2 260 // SMTP password (if required) if you use %p as the password Roundcube
d206c1 261 // will use the current user's password for login
acc005 262 $config['smtp_pass'] = '';
4e17e6 263
d206c1 264 // SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
S 265 // best server supported one)
acc005 266 $config['smtp_auth_type'] = '';
d206c1 267
63d4d6 268 // Optional SMTP authentication identifier to be used as authorization proxy
acc005 269 $config['smtp_auth_cid'] = null;
63d4d6 270
a1fe6b 271 // Optional SMTP authentication password to be used for smtp_auth_cid
acc005 272 $config['smtp_auth_pw'] = null;
a39212 273
aca3d2 274 // SMTP HELO host 
S 275 // Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages 
276 // Leave this blank and you will get the server variable 'server_name' or 
b07426 277 // localhost if that isn't defined.
acc005 278 $config['smtp_helo_host'] = '';
aca3d2 279
bc94e2 280 // SMTP connection timeout, in seconds. Default: 0 (use default_socket_timeout)
cd9e41 281 // Note: There's a known issue where using ssl connection with
AM 282 // timeout > 0 causes connection errors (https://bugs.php.net/bug.php?id=54511)
acc005 283 $config['smtp_timeout'] = 0;
b07426 284
357f9c 285 // SMTP socket context options
AM 286 // See http://php.net/manual/en/context.ssl.php
287 // The example below enables server certificate validation, and
288 // requires 'smtp_timeout' to be non zero.
289 // $config['smtp_conn_options'] = array(
290 //   'ssl'         => array(
109bcc 291 //     'verify_peer'  => true,
AM 292 //     'verify_depth' => 3,
293 //     'cafile'       => '/etc/openssl/certs/ca.crt',
357f9c 294 //   ),
AM 295 // );
296 $config['smtp_conn_options'] = null;
297
109bcc 298
b07426 299 // ----------------------------------
AM 300 // LDAP
301 // ----------------------------------
302
303 // Type of LDAP cache. Supported values: 'db', 'apc' and 'memcache'.
acc005 304 $config['ldap_cache'] = 'db';
b07426 305
AM 306 // Lifetime of LDAP cache. Possible units: s, m, h, d, w
acc005 307 $config['ldap_cache_ttl'] = '10m';
f07d23 308
a5c03d 309
2d08c5 310 // ----------------------------------
A 311 // SYSTEM
312 // ----------------------------------
64608b 313
2d08c5 314 // THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA.
A 315 // ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING!
acc005 316 $config['enable_installer'] = false;
4e17e6 317
e04e31 318 // don't allow these settings to be overriden by the user
acc005 319 $config['dont_override'] = array();
e04e31 320
d01f9f 321 // List of disabled UI elements/actions
AM 322 $config['disabled_actions'] = array();
323
4a05e8 324 // define which settings should be listed under the 'advanced' block
TB 325 // which is hidden by default
326 $config['advanced_prefs'] = array();
327
c04b23 328 // provide an URL where a user can get support for this Roundcube installation
T 329 // PLEASE DO NOT LINK TO THE ROUNDCUBE.NET WEBSITE HERE!
acc005 330 $config['support_url'] = '';
c04b23 331
T 332 // replace Roundcube logo with this image
333 // specify an URL relative to the document root of this Roundcube installation
d81d69 334 // an array can be used to specify different logos for specific template files, '*' for default logo
P 335 // for example array("*" => "/images/roundcube_logo.png", "messageprint" => "/images/roundcube_logo_print.png")
acc005 336 $config['skin_logo'] = null;
c04b23 337
T 338 // automatically create a new Roundcube user when log-in the first time.
339 // a new user will be created once the IMAP login succeeds.
340 // set to false if only registered users can use this service
acc005 341 $config['auto_create_user'] = true;
c04b23 342
565c47 343 // Enables possibility to log in using email address from user identities
acc005 344 $config['user_aliases'] = false;
565c47 345
402c1b 346 // use this folder to store log files
AY 347 // must be writeable for the user who runs PHP process (Apache user if mod_php is being used)
2d08c5 348 // This is used by the 'file' log driver.
57def0 349 $config['log_dir'] = RCUBE_INSTALL_PATH . 'logs/';
d559cb 350
402c1b 351 // use this folder to store temp files
AY 352 // must be writeable for the user who runs PHP process (Apache user if mod_php is being used)
57def0 353 $config['temp_dir'] = RCUBE_INSTALL_PATH . 'temp/';
19862b 354
de8687 355 // expire files in temp_dir after 48 hours
DC 356 // possible units: s, m, h, d, w
357 $config['temp_dir_ttl'] = '48h';
358
2d08c5 359 // enforce connections over https
A 360 // with this option enabled, all non-secure connections will be redirected.
361 // set the port for the ssl connection as value of this option if it differs from the default 443
acc005 362 $config['force_https'] = false;
acb08f 363
00e18b 364 // tell PHP that it should work as under secure connection
A 365 // even if it doesn't recognize it as secure ($_SERVER['HTTPS'] is not set)
366 // e.g. when you're running Roundcube behind a https proxy
377bc6 367 // this option is mutually exclusive to 'force_https' and only either one of them should be set to true.
acc005 368 $config['use_https'] = false;
00e18b 369
1cca4f 370 // Allow browser-autocompletion on login form.
A 371 // 0 - disabled, 1 - username and host only, 2 - username, host, password
acc005 372 $config['login_autocomplete'] = 0;
fbe24e 373
c72325 374 // Forces conversion of logins to lower case.
AM 375 // 0 - disabled, 1 - only domain part, 2 - domain and local part.
df95e7 376 // If users authentication is case-insensitive this must be enabled.
AM 377 // Note: After enabling it all user records need to be updated, e.g. with query:
378 //       UPDATE users SET username = LOWER(username);
acc005 379 $config['login_lc'] = 2;
ae39c4 380
a5c03d 381 // Maximum length (in bytes) of logon username and password.
AM 382 $config['login_username_maxlen'] = 1024;
383 $config['login_password_maxlen'] = 1024;
384
385 // Logon username filter. Regular expression for use with preg_match().
386 // Example: '/^[a-z0-9_@.-]+$/'
387 $config['login_username_filter'] = null;
388
a15d87 389 // Brute-force attacks prevention.
AM 390 // The value specifies maximum number of failed logon attempts per minute.
391 $config['login_rate_limit'] = 3;
392
95d90f 393 // Includes should be interpreted as PHP files
acc005 394 $config['skin_include_php'] = false;
fd8c50 395
b6267d 396 // display software version on login screen
acc005 397 $config['display_version'] = false;
b6267d 398
95d90f 399 // Session lifetime in minutes
acc005 400 $config['session_lifetime'] = 10;
7902df 401
ae7027 402 // Session domain: .example.org
acc005 403 $config['session_domain'] = '';
cf2da2 404
ae7027 405 // Session name. Default: 'roundcube_sessid'
acc005 406 $config['session_name'] = null;
bd34ca 407
8d2963 408 // Session authentication cookie name. Default: 'roundcube_sessauth'
TB 409 $config['session_auth_name'] = null;
410
ae7027 411 // Session path. Defaults to PHP session.cookie_path setting.
acc005 412 $config['session_path'] = null;
ae7027 413
4df4ab 414 // Backend to use for session storage. Can either be 'db' (default), 'redis', 'memcache', or 'php'
C 415 //
42de33 416 // If set to 'memcache', a list of servers need to be specified in 'memcache_hosts'
63e992 417 // Make sure the Memcache extension (http://pecl.php.net/package/memcache) version >= 2.0.0 is installed
4df4ab 418 //
C 419 // If set to 'redis', a server needs to be specified in 'redis_hosts'
420 // Make sure the Redis extension (http://pecl.php.net/package/redis) version >= 2.0.0 is installed
421 //
42de33 422 // Setting this value to 'php' will use the default session save handler configured in PHP
acc005 423 $config['session_storage'] = 'db';
63e992 424
T 425 // Use these hosts for accessing memcached
71ee56 426 // Define any number of hosts in the form of hostname:port or unix:///path/to/socket.file
acc005 427 $config['memcache_hosts'] = null; // e.g. array( 'localhost:11211', '192.168.1.12:11211', 'unix:///var/tmp/memcached.sock' );
63e992 428
de3fc1 429 // Controls the use of a persistent connections to memcache servers
TB 430 // See http://php.net/manual/en/memcache.addserver.php
431 $config['memcache_pconnect'] = true;
432
433 // Value in seconds which will be used for connecting to the daemon
434 // See http://php.net/manual/en/memcache.addserver.php
435 $config['memcache_timeout'] = 1;
436
437 // Controls how often a failed server will be retried (value in seconds).
438 // Setting this parameter to -1 disables automatic retry.
439 // See http://php.net/manual/en/memcache.addserver.php
440 $config['memcache_retry_interval'] = 15;
441
4df4ab 442 // use this for accessing redis
C 443 // currently only one host is supported. cluster support may come in a future release.
444 // you can pass 4 fields, host, port, database and password.
445 // unset fields will be set to the default values host=127.0.0.1, port=6379, database=0, password=  (empty)
446
447 $config['redis_hosts'] = null; // e.g. array( 'localhost:6379' );  array( '192.168.1.1:6379:1:secret' );
448
3fca23 449 // check client IP in session authorization
acc005 450 $config['ip_check'] = false;
4e17e6 451
ef721f 452 // List of trusted proxies
FE 453 // X_FORWARDED_* and X_REAL_IP headers are only accepted from these IPs
454 $config['proxy_whitelist'] = array();
455
a77cf2 456 // check referer of incoming requests
acc005 457 $config['referer_check'] = false;
a77cf2 458
c170bf 459 // X-Frame-Options HTTP header value sent to prevent from Clickjacking.
T 460 // Possible values: sameorigin|deny. Set to false in order to disable sending them
acc005 461 $config['x_frame_options'] = 'sameorigin';
c170bf 462
e4c660 463 // This key is used for encrypting purposes, like storing of imap password
AM 464 // in the session. For historical reasons it's called DES_key, but it's used
465 // with any configured cipher_method (see below).
acc005 466 $config['des_key'] = 'rcmail-!24ByteDESkey*Str';
bac7d1 467
e4c660 468 // Encryption algorithm. You can use any method supported by openssl.
AM 469 // Default is set for backward compatibility to DES-EDE3-CBC,
470 // but you can choose e.g. AES-256-CBC which we consider a better choice.
471 $config['cipher_method'] = 'DES-EDE3-CBC';
472
2d08c5 473 // Automatically add this domain to user names for login
A 474 // Only for IMAP servers that require full e-mail addresses for login
475 // Specify an array with 'host' => 'domain' values to support multiple hosts
6a642d 476 // Supported replacement variables:
A 477 // %h - user's IMAP hostname
d359dc 478 // %n - hostname ($_SERVER['SERVER_NAME'])
B 479 // %t - hostname without the first part
480 // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
11be93 481 // %z - IMAP domain (IMAP hostname without the first part)
d359dc 482 // For example %n = mail.domain.tld, %t = domain.tld
acc005 483 $config['username_domain'] = '';
2d08c5 484
96f59c 485 // Force domain configured in username_domain to be used for login.
AM 486 // Any domain in username will be replaced by username_domain.
487 $config['username_domain_forced'] = false;
488
2d08c5 489 // This domain will be used to form e-mail addresses of new users
A 490 // Specify an array with 'host' => 'domain' values to support multiple hosts
bb8721 491 // Supported replacement variables:
A 492 // %h - user's IMAP hostname
493 // %n - http hostname ($_SERVER['SERVER_NAME'])
494 // %d - domain (http hostname without the first part)
11be93 495 // %z - IMAP domain (IMAP hostname without the first part)
d359dc 496 // For example %n = mail.domain.tld, %t = domain.tld
acc005 497 $config['mail_domain'] = '';
2d08c5 498
4ca97c 499 // Password character set.
SM 500 // If your authentication backend supports it, use "UTF-8".
501 // Otherwise, use the appropriate character set.
502 // Defaults to ISO-8859-1 for backward compatibility.
acc005 503 $config['password_charset'] = 'ISO-8859-1';
2d08c5 504
A 505 // How many seconds must pass between emails sent by a user
acc005 506 $config['sendmail_delay'] = 0;
2d08c5 507
751b22 508 // Maximum number of recipients per message. Default: 0 (no limit)
acc005 509 $config['max_recipients'] = 0; 
751b22 510
707712 511 // Maximum allowed number of members of an address group. Default: 0 (no limit)
d1851b 512 // If 'max_recipients' is set this value should be less or equal
acc005 513 $config['max_group_members'] = 0; 
d1851b 514
9bacb2 515 // Name your service. This is displayed on the login screen and in the window title
acc005 516 $config['product_name'] = 'Roundcube Webmail';
2d08c5 517
9bacb2 518 // Add this user-agent to message headers when sending
TB 519 $config['useragent'] = 'Roundcube Webmail/'.RCMAIL_VERSION;
2d08c5 520
A 521 // try to load host-specific configuration
522 // see http://trac.roundcube.net/wiki/Howto_Config for more details
acc005 523 $config['include_host_config'] = false;
2d08c5 524
A 525 // path to a text file which will be added to each sent message
e019f2 526 // paths are relative to the Roundcube root folder
acc005 527 $config['generic_message_footer'] = '';
2d08c5 528
5852c1 529 // path to a text file which will be added to each sent HTML message
e019f2 530 // paths are relative to the Roundcube root folder
acc005 531 $config['generic_message_footer_html'] = '';
5852c1 532
2d08c5 533 // add a received header to outgoing mails containing the creators IP and hostname
acc005 534 $config['http_received_header'] = false;
2d08c5 535
A 536 // Whether or not to encrypt the IP address and the host name
537 // these could, in some circles, be considered as sensitive information;
538 // however, for the administrator, these could be invaluable help
539 // when tracking down issues.
acc005 540 $config['http_received_header_encrypt'] = false;
2d08c5 541
ac8edb 542 // This string is used as a delimiter for message headers when sending
A 543 // a message via mail() function. Leave empty for auto-detection
acc005 544 $config['mail_header_delimiter'] = NULL;
2d08c5 545
6b6f2e 546 // number of chars allowed for line when wrapping text.
T 547 // text wrapping is done when composing/sending messages
acc005 548 $config['line_length'] = 72;
6b6f2e 549
T 550 // send plaintext messages as format=flowed
acc005 551 $config['send_format_flowed'] = true;
2d08c5 552
232535 553 // According to RFC2298, return receipt envelope sender address must be empty.
AM 554 // If this option is true, Roundcube will use user's identity as envelope sender for MDN responses.
acc005 555 $config['mdn_use_from'] = false;
232535 556
2d08c5 557 // Set identities access level:
A 558 // 0 - many identities with possibility to edit all params
559 // 1 - many identities with possibility to edit all params but not email address
560 // 2 - one identity with possibility to edit all params
561 // 3 - one identity with possibility to edit all params but not email address
f12585 562 // 4 - one identity with possibility to edit only signature
acc005 563 $config['identities_level'] = 0;
2d08c5 564
3cc1af 565 // Maximum size of uploaded image in kilobytes
AM 566 // Images (in html signatures) are stored in database as data URIs
567 $config['identity_image_size'] = 64;
568
f7b58a 569 // Mimetypes supported by the browser.
T 570 // attachments of these types will open in a preview window
571 // either a comma-separated list or an array: 'text/plain,text/html,text/xml,image/jpeg,image/gif,image/png,application/pdf'
acc005 572 $config['client_mimetypes'] = null;  # null == default
f7b58a 573
0a8397 574 // Path to a local mime magic database file for PHPs finfo extension.
TB 575 // Set to null if the default path should be used.
acc005 576 $config['mime_magic'] = null;
0a8397 577
9e1605 578 // Absolute path to a local mime.types mapping table file.
0a8397 579 // This is used to derive mime-types from the filename extension or vice versa.
9e1605 580 // Such a file is usually part of the apache webserver. If you don't find a file named mime.types on your system,
TB 581 // download it from http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types
acc005 582 $config['mime_types'] = null;
2d08c5 583
2ea271 584 // path to imagemagick identify binary (if not set we'll use Imagick or GD extensions)
acc005 585 $config['im_identify_path'] = null;
0501b6 586
2ea271 587 // path to imagemagick convert binary (if not set we'll use Imagick or GD extensions)
acc005 588 $config['im_convert_path'] = null;
0501b6 589
031491 590 // Size of thumbnails from image attachments displayed below the message content.
TB 591 // Note: whether images are displayed at all depends on the 'inline_images' option.
592 // Set to 0 to display images in full size.
acc005 593 $config['image_thumbnail_size'] = 240;
031491 594
0501b6 595 // maximum size of uploaded contact photos in pixel
acc005 596 $config['contact_photo_size'] = 160;
0501b6 597
2d08c5 598 // Enable DNS checking for e-mail address validation
acc005 599 $config['email_dns_check'] = false;
2d08c5 600
e04e31 601 // Disables saving sent messages in Sent folder (like gmail) (Default: false)
AM 602 // Note: useful when SMTP server stores sent mail in user mailbox
acc005 603 $config['no_save_sent_messages'] = false;
e04e31 604
681ba6 605 // Improve system security by using special URL with security token.
AM 606 // This can be set to a number defining token length. Default: 16.
607 // Warning: This requires http server configuration. Sample:
608 //    RewriteRule ^/roundcubemail/[a-f0-9]{16}/(.*) /roundcubemail/$1 [PT]
609 //    Alias /roundcubemail /var/www/roundcubemail/
610 // Note: Use assets_path to not prevent the browser from caching assets
611 $config['use_secure_urls'] = false;
612
613 // Allows to define separate server/path for image/js/css files
614 // Warning: If the domain is different cross-domain access to some
615 // resources need to be allowed
616 // Sample:
617 //    <FilesMatch ".(eot|ttf|woff)">
618 //    Header set Access-Control-Allow-Origin "*"
619 //    </FilesMatch>
620 $config['assets_path'] = '';
621
622 // While assets_path is for the browser, assets_dir informs
623 // PHP code about the location of asset files in filesystem
624 $config['assets_dir'] = '';
625
626
2d08c5 627 // ----------------------------------
A 628 // PLUGINS
629 // ----------------------------------
630
631 // List of active plugins (in plugins/ directory)
acc005 632 $config['plugins'] = array();
2d08c5 633
A 634 // ----------------------------------
635 // USER INTERFACE
636 // ----------------------------------
637
f52c93 638 // default messages sort column. Use empty value for default server's sorting, 
e0efd8 639 // or 'arrival', 'date', 'subject', 'from', 'to', 'fromto', 'size', 'cc'
acc005 640 $config['message_sort_col'] = '';
2d08c5 641
f52c93 642 // default messages sort order
acc005 643 $config['message_sort_order'] = 'DESC';
2d08c5 644
A 645 // These cols are shown in the message list. Available cols are:
e0efd8 646 // subject, from, to, fromto, cc, replyto, date, size, status, flag, attachment, 'priority'
acc005 647 $config['list_cols'] = array('subject', 'status', 'fromto', 'date', 'size', 'flag', 'attachment');
2d08c5 648
c8ae24 649 // the default locale setting (leave empty for auto-detection)
T 650 // RFC1766 formatted language name like en_US, de_DE, de_CH, fr_FR, pt_BR
acc005 651 $config['language'] = null;
4e17e6 652
1cc9e2 653 // use this format for date display (date or strftime format)
acc005 654 $config['date_format'] = 'Y-m-d';
1cc9e2 655
T 656 // give this choice of date formats to the user to select from
b32fab 657 // Note: do not use ambiguous formats like m/d/Y
AM 658 $config['date_formats'] = array('Y-m-d', 'Y/m/d', 'Y.m.d', 'd-m-Y', 'd/m/Y', 'd.m.Y', 'j.n.Y');
1cc9e2 659
T 660 // use this format for time display (date or strftime format)
acc005 661 $config['time_format'] = 'H:i';
1cc9e2 662
T 663 // give this choice of time formats to the user to select from
acc005 664 $config['time_formats'] = array('G:i', 'H:i', 'g:i a', 'h:i A');
1cc9e2 665
T 666 // use this format for short date display (derived from date_format and time_format)
acc005 667 $config['date_short'] = 'D H:i';
4e17e6 668
1cc9e2 669 // use this format for detailed date/time formatting (derived from date_format and time_format)
acc005 670 $config['date_long'] = 'Y-m-d H:i';
4e17e6 671
1966c5 672 // store draft message is this mailbox
S 673 // leave blank if draft messages should not be stored
d08333 674 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
acc005 675 $config['drafts_mbox'] = 'Drafts';
1966c5 676
b4b081 677 // store spam messages in this mailbox
d08333 678 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
acc005 679 $config['junk_mbox'] = 'Junk';
b4b081 680
4e17e6 681 // store sent message is this mailbox
T 682 // leave blank if sent messages should not be stored
d08333 683 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
acc005 684 $config['sent_mbox'] = 'Sent';
4e17e6 685
T 686 // move messages to this folder when deleting them
687 // leave blank if they should be deleted directly
d08333 688 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
acc005 689 $config['trash_mbox'] = 'Trash';
4e17e6 690
4bb44c 691 // automatically create the above listed default folders on user login
acc005 692 $config['create_default_folders'] = false;
b2ff3d 693
c8c1e0 694 // protect the default folders from renames, deletes, and subscription changes
acc005 695 $config['protect_default_folders'] = true;
c8c1e0 696
dc0b50 697 // Disable localization of the default folder names listed above
AM 698 $config['show_real_foldernames'] = false;
699
2d08c5 700 // if in your system 0 quota means no limit set this option to true 
acc005 701 $config['quota_zero_as_unlimited'] = false;
876b15 702
996066 703 // Make use of the built-in spell checker. It is based on GoogieSpell.
acc005 704 $config['enable_spellcheck'] = true;
ed5d29 705
66df08 706 // Enables spellchecker exceptions dictionary.
A 707 // Setting it to 'shared' will make the dictionary shared by all users.
acc005 708 $config['spellcheck_dictionary'] = false;
66df08 709
b52166 710 // Set the spell checking engine. Possible values:
507dad 711 // - 'googie'  - the default (also used for connecting to Nox Spell Server, see 'spellcheck_uri' setting)
b52166 712 // - 'pspell'  - requires the PHP Pspell module and aspell installed
TB 713 // - 'enchant' - requires the PHP Enchant module
714 // - 'atd'     - install your own After the Deadline server or check with the people at http://www.afterthedeadline.com before using their API
507dad 715 // Since Google shut down their public spell checking service, the default settings
TB 716 // connect to http://spell.roundcube.net which is a hosted service provided by Roundcube.
717 // You can connect to any other googie-compliant service by setting 'spellcheck_uri' accordingly.
acc005 718 $config['spellcheck_engine'] = 'googie';
5d2b7f 719
b52166 720 // For locally installed Nox Spell Server or After the Deadline services,
TB 721 // please specify the URI to call it.
722 // Get Nox Spell Server from http://orangoo.com/labs/?page_id=72 or
723 // the After the Deadline package from http://www.afterthedeadline.com.
724 // Leave empty to use the public API of service.afterthedeadline.com
acc005 725 $config['spellcheck_uri'] = '';
996066 726
T 727 // These languages can be selected for spell checking.
728 // Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch');
01a8c5 729 // Leave empty for default set of available language.
acc005 730 $config['spellcheck_languages'] = NULL;
996066 731
66df08 732 // Makes that words with all letters capitalized will be ignored (e.g. GOOGLE)
acc005 733 $config['spellcheck_ignore_caps'] = false;
66df08 734
A 735 // Makes that words with numbers will be ignored (e.g. g00gle)
acc005 736 $config['spellcheck_ignore_nums'] = false;
66df08 737
A 738 // Makes that words with symbols will be ignored (e.g. g@@gle)
acc005 739 $config['spellcheck_ignore_syms'] = false;
66df08 740
62c861 741 // Use this char/string to separate recipients when composing a new message
acc005 742 $config['recipients_separator'] = ',';
62c861 743
acf8d6 744 // Number of lines at the end of a message considered to contain the signature.
TB 745 // Increase this value if signatures are not properly detected and colored
746 $config['sig_max_lines'] = 15;
747
2d08c5 748 // don't let users set pagesize to more than this value if set
acc005 749 $config['max_pagesize'] = 200;
967b34 750
f22654 751 // Minimal value of user's 'refresh_interval' setting (in seconds)
acc005 752 $config['min_refresh_interval'] = 60;
2471d3 753
4171c5 754 // Enables files upload indicator. Requires APC installed and enabled apc.rfc1867 option.
A 755 // By default refresh time is set to 1 second. You can set this value to true
756 // or any integer value indicating number of seconds.
acc005 757 $config['upload_progress'] = false;
4171c5 758
63fda8 759 // Specifies for how many seconds the Undo button will be available
A 760 // after object delete action. Currently used with supporting address book sources.
761 // Setting it to 0, disables the feature.
acc005 762 $config['undo_timeout'] = 0;
63fda8 763
9c41ba 764 // A static list of canned responses which are immutable for the user
TB 765 $config['compose_responses_static'] = array(
766 //  array('name' => 'Canned Response 1', 'text' => 'Static Response One'),
767 //  array('name' => 'Canned Response 2', 'text' => 'Static Response Two'),
768 );
769
2d08c5 770 // ----------------------------------
A 771 // ADDRESSBOOK SETTINGS
772 // ----------------------------------
aec82b 773
6153e2 774 // This indicates which type of address book to use. Possible choises:
5526f9 775 // 'sql' (default), 'ldap' and ''.
6153e2 776 // If set to 'ldap' then it will look at using the first writable LDAP
4f9c83 777 // address book as the primary address book and it will not display the
S 778 // SQL address book in the 'Address Book' view.
5526f9 779 // If set to '' then no address book will be displayed or only the
JD 780 // addressbook which is created by a plugin (like CardDAV).
acc005 781 $config['address_book_type'] = 'sql';
4f9c83 782
S 783 // In order to enable public ldap search, configure an array like the Verisign
784 // example further below. if you would like to test, simply uncomment the example.
ecf295 785 // Array key must contain only safe characters, ie. a-zA-Z0-9_
acc005 786 $config['ldap_public'] = array();
5f25a1 787
4f9c83 788 // If you are going to use LDAP for individual address books, you will need to 
S 789 // set 'user_specific' to true and use the variables to generate the appropriate DNs to access it.
790 //
791 // The recommended directory structure for LDAP is to store all the address book entries
792 // under the users main entry, e.g.:
793 //
794 //  o=root
795 //   ou=people
796 //    uid=user@domain
3b9a53 797 //  mail=contact@contactdomain
T 798 //
4f9c83 799 // So the base_dn would be uid=%fu,ou=people,o=root
S 800 // The bind_dn would be the same as based_dn or some super user login.
3b9a53 801 /* 
f11541 802  * example config for Verisign directory
eea43f 803  *
acc005 804 $config['ldap_public']['Verisign'] = array(
3b9a53 805   'name'          => 'Verisign.com',
bb8721 806   // Replacement variables supported in host names:
A 807   // %h - user's IMAP hostname
d359dc 808   // %n - hostname ($_SERVER['SERVER_NAME'])
B 809   // %t - hostname without the first part
810   // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
11be93 811   // %z - IMAP domain (IMAP hostname without the first part)
d359dc 812   // For example %n = mail.domain.tld, %t = domain.tld
3b9a53 813   'hosts'         => array('directory.verisign.com'),
T 814   'port'          => 389,
c64bee 815   'use_tls'       => false,
0c5210 816   'ldap_version'  => 3,       // using LDAPv3
e114a6 817   'network_timeout' => 10,    // The timeout (in seconds) for connect + bind arrempts. This is only supported in PHP >= 5.3.0 with OpenLDAP 2.x
3b9a53 818   'user_specific' => false,   // If true the base_dn, bind_dn and bind_pass default to the user's IMAP login.
221b40 819   // When 'user_specific' is enabled following variables can be used in base_dn/bind_dn config:
3b9a53 820   // %fu - The full username provided, assumes the username is an email
T 821   //       address, uses the username_domain value if not an email address.
822   // %u  - The username prior to the '@'.
823   // %d  - The domain name after the '@'.
f76765 824   // %dc - The domain name hierarchal string e.g. "dc=test,dc=domain,dc=com"
1148c6 825   // %dn - DN found by ldap search when search_filter/search_base_dn are used
3b9a53 826   'base_dn'       => '',
T 827   'bind_dn'       => '',
828   'bind_pass'     => '',
1148c6 829   // It's possible to bind for an individual address book
A 830   // The login name is used to search for the DN to bind with
831   'search_base_dn' => '',
832   'search_filter'  => '',   // e.g. '(&(objectClass=posixAccount)(uid=%u))'
2d08ec 833   // DN and password to bind as before searching for bind DN, if anonymous search is not allowed
A 834   'search_bind_dn' => '',
835   'search_bind_pw' => '',
0f6341 836   // Base DN and filter used for resolving the user's domain root DN which feeds the %dc variables
TB 837   // Leave empty to skip this lookup and derive the root DN from the username domain
838   'domain_base_dn' => '',
839   'domain_filter'  => '',
3ce7c5 840   // Optional map of replacement strings => attributes used when binding for an individual address book
TB 841   'search_bind_attrib' => array(),  // e.g. array('%udc' => 'ou')
c041d5 842   // Default for %dn variable if search doesn't return DN value
A 843   'search_dn_default' => '',
4d982d 844   // Optional authentication identifier to be used as SASL authorization proxy
A 845   // bind_dn need to be empty
846   'auth_cid'       => '',
847   // SASL authentication method (for proxy auth), e.g. DIGEST-MD5
848   'auth_method'    => '',
2d3e2b 849   // Indicates if the addressbook shall be hidden from the list.
5c9d1f 850   // With this option enabled you can still search/view contacts.
A 851   'hidden'        => false,
2d3e2b 852   // Indicates if the addressbook shall not list contacts but only allows searching.
T 853   'searchonly'    => false,
0c5210 854   // Indicates if we can write to the LDAP directory or not.
3b9a53 855   // If writable is true then these fields need to be populated:
T 856   // LDAP_Object_Classes, required_fields, LDAP_rdn
0c5210 857   'writable'       => false,
A 858   // To create a new contact these are the object classes to specify
859   // (or any other classes you wish to use).
860   'LDAP_Object_Classes' => array('top', 'inetOrgPerson'),
861   // The RDN field that is used for new entries, this field needs
862   // to be one of the search_fields, the base of base_dn is appended
863   // to the RDN to insert into the LDAP directory.
ca3d76 864   'LDAP_rdn'       => 'cn',
0c5210 865   // The required fields needed to build a new contact as required by
A 866   // the object classes (can include additional fields not required by the object classes).
867   'required_fields' => array('cn', 'sn', 'mail'),
868   'search_fields'   => array('mail', 'cn'),  // fields to search in
869   // mapping of contact fields to directory attributes
c8c4ca 870   //   1. for every attribute one can specify the number of values (limit) allowed.
AM 871   //      default is 1, a wildcard * means unlimited
872   //   2. another possible parameter is separator character for composite fields
873   //   3. it's possible to define field format for write operations, e.g. for date fields
874   //      example: 'birthday:date[YmdHis\\Z]'
0c5210 875   'fieldmap' => array(
a605b2 876     // Roundcube  => LDAP:limit
0501b6 877     'name'        => 'cn',
T 878     'surname'     => 'sn',
879     'firstname'   => 'givenName',
b2c3c3 880     'jobtitle'    => 'title',
a605b2 881     'email'       => 'mail:*',
0501b6 882     'phone:home'  => 'homePhone',
T 883     'phone:work'  => 'telephoneNumber',
884     'phone:mobile' => 'mobile',
ca3d76 885     'phone:pager' => 'pager',
e43cc4 886     'phone:workfax' => 'facsimileTelephoneNumber',
0501b6 887     'street'      => 'street',
T 888     'zipcode'     => 'postalCode',
ca3d76 889     'region'      => 'st',
0501b6 890     'locality'    => 'l',
a605b2 891     // if you country is a complex object, you need to configure 'sub_fields' below
T 892     'country'      => 'c',
b563fc 893     'organization' => 'o',
a605b2 894     'department'   => 'ou',
T 895     'jobtitle'     => 'title',
896     'notes'        => 'description',
e43cc4 897     'photo'        => 'jpegPhoto',
a605b2 898     // these currently don't work:
T 899     // 'manager'       => 'manager',
900     // 'assistant'     => 'secretary',
0501b6 901   ),
a605b2 902   // Map of contact sub-objects (attribute name => objectClass(es)), e.g. 'c' => 'country'
T 903   'sub_fields' => array(),
3f250a 904   // Generate values for the following LDAP attributes automatically when creating a new record
TB 905   'autovalues' => array(
906   // 'uid'  => 'md5(microtime())',               // You may specify PHP code snippets which are then eval'ed 
907   // 'mail' => '{givenname}.{sn}@mydomain.com',  // or composite strings with placeholders for existing attributes
908   ),
a6d418 909   'sort'           => 'cn',         // The field to sort the listing by.
TB 910   'scope'          => 'sub',        // search mode: sub|base|list
911   'filter'         => '(objectClass=inetOrgPerson)',      // used for basic listing (if not empty) and will be &'d with search queries. example: status=act
912   'fuzzy_search'   => true,         // server allows wildcard search
913   'vlv'            => false,        // Enable Virtual List View to more efficiently fetch paginated data (if server supports it)
914   'vlv_search'     => false,        // Use Virtual List View functions for autocompletion searches (if server supports it)
915   '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
916   'config_root_dn' => 'cn=config',  // Root DN to search config entries (e.g. vlv indexes)
917   'sizelimit'      => '0',          // Enables you to limit the count of entries fetched. Setting this to 0 means no limit.
918   'timelimit'      => '0',          // Sets the number of seconds how long is spend on the search. Setting this to 0 means no limit.
919   'referrals'      => false,        // Sets the LDAP_OPT_REFERRALS option. Mostly used in multi-domain Active Directory setups
d51900 920   'dereference'    => 0,            // Sets the LDAP_OPT_DEREF option. One of: LDAP_DEREF_NEVER, LDAP_DEREF_SEARCHING, LDAP_DEREF_FINDING, LDAP_DEREF_ALWAYS
AM 921                                     // Used where addressbook contains aliases to objects elsewhere in the LDAP tree.
d1e08f 922
T 923   // definition for contact groups (uncomment if no groups are supported)
924   // for the groups base_dn, the user replacements %fu, %u, $d and %dc work as for base_dn (see above)
925   // if the groups base_dn is empty, the contact base_dn is used for the groups as well
15d762 926   // -> in this case, assure that groups and contacts are separated due to the concernig filters! 
a6d418 927   'groups'  => array(
3ce7c5 928     'base_dn'           => '',
TB 929     'scope'             => 'sub',       // Search mode: sub|base|list
930     'filter'            => '(objectClass=groupOfNames)',
931     'object_classes'    => array('top', 'groupOfNames'),   // Object classes to be assigned to new groups
932     'member_attr'       => 'member',   // Name of the default member attribute, e.g. uniqueMember
933     'name_attr'         => 'cn',       // Attribute to be used as group name
934     'email_attr'        => 'mail',     // Group email address attribute (e.g. for mailing lists)
935     'member_filter'     => '(objectclass=*)',  // Optional filter to use when querying for group members
936     'vlv'               => false,      // Use VLV controls to list groups
937     'class_member_attr' => array(      // Mapping of group object class to member attribute used in these objects
938       'groupofnames'       => 'member',
939       'groupofuniquenames' => 'uniquemember'
940     ),
6039aa 941   ),
e43cc4 942   // this configuration replaces the regular groups listing in the directory tree with
TB 943   // a hard-coded list of groups, each listing entries with the configured base DN and filter.
944   // if the 'groups' option from above is set, it'll be shown as the first entry with the name 'Groups'
945   'group_filters' => array(
946     'departments' => array(
947       'name'    => 'Company Departments',
948       'scope'   => 'list',
949       'base_dn' => 'ou=Groups,dc=mydomain,dc=com',
950       'filter'  => '(|(objectclass=groupofuniquenames)(objectclass=groupofurls))',
9eaf68 951       'name_attr' => 'cn',
e43cc4 952     ),
TB 953     'customers' => array(
954       'name'    => 'Customers',
955       'scope'   => 'sub',
956       'base_dn' => 'ou=Customers,dc=mydomain,dc=com',
957       'filter'  => '(objectClass=inetOrgPerson)',
9eaf68 958       'name_attr' => 'sn',
e43cc4 959     ),
2c8e84 960   ),
T 961 );
962 */
c296b8 963
A 964 // An ordered array of the ids of the addressbooks that should be searched
965 // when populating address autocomplete fields server-side. ex: array('sql','Verisign');
acc005 966 $config['autocomplete_addressbooks'] = array('sql');
b19097 967
c296b8 968 // The minimum number of characters required to be typed in an autocomplete field
A 969 // before address books will be searched. Most useful for LDAP directories that
970 // may need to do lengthy results building given overly-broad searches
acc005 971 $config['autocomplete_min_length'] = 1;
c296b8 972
0213f8 973 // Number of parallel autocomplete requests.
A 974 // If there's more than one address book, n parallel (async) requests will be created,
975 // where each request will search in one address book. By default (0), all address
976 // books are searched in one request.
acc005 977 $config['autocomplete_threads'] = 0;
0213f8 978
A 979 // Max. numer of entries in autocomplete popup. Default: 15.
acc005 980 $config['autocomplete_max'] = 15;
0213f8 981
0501b6 982 // show address fields in this order
T 983 // available placeholders: {street}, {locality}, {zipcode}, {country}, {region}
acc005 984 $config['address_template'] = '{street}<br/>{locality} {zipcode}<br/>{country} {region}';
0501b6 985
f21a04 986 // Matching mode for addressbook search (including autocompletion)
A 987 // 0 - partial (*abc*), default
988 // 1 - strict (abc)
989 // 2 - prefix (abc*)
990 // Note: For LDAP sources fuzzy_search must be enabled to use 'partial' or 'prefix' mode
acc005 991 $config['addressbook_search_mode'] = 0;
f21a04 992
791ee6 993 // List of fields used on contacts list and for autocompletion searches
AM 994 // Warning: These are field names not LDAP attributes (see 'fieldmap' setting)!
995 $config['contactlist_fields'] = array('name', 'firstname', 'surname', 'email');
996
36d004 997 // Template of contact entry on the autocompletion list.
AM 998 // You can use contact fields as: name, email, organization, department, etc.
999 // See program/steps/addressbook/func.inc for a list
1000 $config['contact_search_name'] = '{name} <{email}>';
1001
2d08c5 1002 // ----------------------------------
A 1003 // USER PREFERENCES
1004 // ----------------------------------
4e17e6 1005
e55ab0 1006 // Use this charset as fallback for message decoding
acc005 1007 $config['default_charset'] = 'ISO-8859-1';
e55ab0 1008
67effe 1009 // skin name: folder from skins/
acc005 1010 $config['skin'] = 'larry';
e58df3 1011
3863a9 1012 // Enables using standard browser windows (that can be handled as tabs)
AM 1013 // instead of popup windows
acc005 1014 $config['standard_windows'] = false;
3863a9 1015
08ffd9 1016 // show up to X items in messages list view
acc005 1017 $config['mail_pagesize'] = 50;
08ffd9 1018
A 1019 // show up to X items in contacts list view
acc005 1020 $config['addressbook_pagesize'] = 50;
4e17e6 1021
438753 1022 // sort contacts by this col (preferably either one of name, firstname, surname)
acc005 1023 $config['addressbook_sort_col'] = 'surname';
438753 1024
f9a967 1025 // the way how contact names are displayed in the list
T 1026 // 0: display name
1027 // 1: (prefix) firstname middlename surname (suffix)
1028 // 2: (prefix) surname firstname middlename (suffix)
1029 // 3: (prefix) surname, firstname middlename (suffix)
acc005 1030 $config['addressbook_name_listing'] = 0;
f9a967 1031
4e17e6 1032 // use this timezone to display date/time
5879c0 1033 // valid timezone identifers are listed here: php.net/manual/en/timezones.php
T 1034 // 'auto' will use the browser's timezone settings
acc005 1035 $config['timezone'] = 'auto';
4647e1 1036
4e17e6 1037 // prefer displaying HTML messages
acc005 1038 $config['prefer_html'] = true;
4e17e6 1039
2a4135 1040 // display remote inline images
A 1041 // 0 - Never, always ask
1042 // 1 - Ask if sender is not in address book
1043 // 2 - Always show inline images
acc005 1044 $config['show_images'] = 0;
712b30 1045
271efe 1046 // open messages in new window
acc005 1047 $config['message_extwin'] = false;
271efe 1048
TB 1049 // open message compose form in new window
acc005 1050 $config['compose_extwin'] = false;
271efe 1051
b19097 1052 // compose html formatted messages by default
6ca1e6 1053 //  0 - never,
AM 1054 //  1 - always,
1055 //  2 - on reply to HTML message,
1056 //  3 - on forward or reply to HTML message
1057 //  4 - always, except when replying to plain text message
acc005 1058 $config['htmleditor'] = 0;
b19097 1059
44b47d 1060 // save copies of compose messages in the browser's local storage
TB 1061 // for recovery in case of browser crashes and session timeout.
1062 $config['compose_save_localstorage'] = true;
1063
30233b 1064 // show pretty dates as standard
acc005 1065 $config['prettydate'] = true;
4e17e6 1066
d656f1 1067 // save compose message every 300 seconds (5min)
acc005 1068 $config['draft_autosave'] = 300;
0566ad 1069
b19097 1070 // default setting if preview pane is enabled
acc005 1071 $config['preview_pane'] = false;
b19097 1072
bc4960 1073 // Mark as read when viewed in preview pane (delay in seconds)
T 1074 // Set to -1 if messages in preview pane should not be marked as read
acc005 1075 $config['preview_pane_mark_read'] = 0;
bc4960 1076
eaa394 1077 // Clear Trash on logout
acc005 1078 $config['logout_purge'] = false;
eaa394 1079
A 1080 // Compact INBOX on logout
acc005 1081 $config['logout_expunge'] = false;
50c753 1082
166b61 1083 // Display attached images below the message body 
acc005 1084 $config['inline_images'] = true;
5e0045 1085
ffae15 1086 // Encoding of long/non-ascii attachment names:
A 1087 // 0 - Full RFC 2231 compatible
1088 // 1 - RFC 2047 for 'name' and RFC 2231 for 'filename' parameter (Thunderbird's default)
1089 // 2 - Full 2047 compatible
acc005 1090 $config['mime_param_folding'] = 1;
ffae15 1091
2d08c5 1092 // Set true if deleted messages should not be displayed
2b5852 1093 // This will make the application run slower
acc005 1094 $config['skip_deleted'] = false;
2b5852 1095
A 1096 // Set true to Mark deleted messages as read as well as deleted
1097 // False means that a message's read status is not affected by marking it as deleted
acc005 1098 $config['read_when_deleted'] = true;
2b5852 1099
ca8a17 1100 // Set to true to never delete messages immediately
A 1101 // Use 'Purge' to remove messages marked as deleted
acc005 1102 $config['flag_for_deletion'] = false;
2b5852 1103
aa8359 1104 // Default interval for auto-refresh requests (in seconds)
AM 1105 // These are requests for system state updates e.g. checking for new messages, etc.
1106 // Setting it to 0 disables the feature.
acc005 1107 $config['refresh_interval'] = 60;
95d90f 1108
2fd975 1109 // If true all folders will be checked for recent messages
acc005 1110 $config['check_all_folders'] = false;
2fd975 1111
e54bb7 1112 // If true, after message delete/move, the next message will be displayed
acc005 1113 $config['display_next'] = true;
e54bb7 1114
cd01dc 1115 // Default messages listing mode. One of 'threads' or 'list'.
AM 1116 $config['default_list_mode'] = 'list';
1117
1118 // 0 - Do not expand threads
1119 // 1 - Expand all threads automatically
1120 // 2 - Expand only threads with unread messages
acc005 1121 $config['autoexpand_threads'] = 0;
1cead0 1122
651c7b 1123 // When replying:
AM 1124 // -1 - don't cite the original message
1125 // 0  - place cursor below the original message
1126 // 1  - place cursor above original message (top posting)
acc005 1127 $config['reply_mode'] = 0;
50f56d 1128
0207c4 1129 // When replying strip original signature from message
acc005 1130 $config['strip_existing_sig'] = true;
0207c4 1131
50f56d 1132 // Show signature:
0207c4 1133 // 0 - Never
T 1134 // 1 - Always
50f56d 1135 // 2 - New messages only
0207c4 1136 // 3 - Forwards and Replies only
acc005 1137 $config['show_sig'] = 1;
0207c4 1138
09225a 1139 // By default the signature is placed depending on cursor position (reply_mode).
AM 1140 // Sometimes it might be convenient to start the reply on top but keep
1141 // the signature below the quoted text (sig_below = true).
1142 $config['sig_below'] = false;
1143
399a2d 1144 // Enables adding of standard separator to the signature
AM 1145 $config['sig_separator'] = true;
1146
47ad83 1147 // Use MIME encoding (quoted-printable) for 8bit characters in message body
acc005 1148 $config['force_7bit'] = false;
47ad83 1149
b975da 1150 // Defaults of the search field configuration.
T 1151 // The array can contain a per-folder list of header fields which should be considered when searching
1152 // The entry with key '*' stands for all folders which do not have a specific list set.
aecdf0 1153 // Please note that folder names should to be in sync with $config['*_mbox'] options
acc005 1154 $config['search_mods'] = null;  // Example: array('*' => array('subject'=>1, 'from'=>1), 'Sent' => array('subject'=>1, 'to'=>1));
b975da 1155
3cacf9 1156 // Defaults of the addressbook search field configuration.
acc005 1157 $config['addressbook_search_mods'] = null;  // Example: array('name'=>1, 'firstname'=>1, 'surname'=>1, 'email'=>1, '*'=>1);
3cacf9 1158
b7f952 1159 // 'Delete always'
A 1160 // This setting reflects if mail should be always deleted
1161 // when moving to Trash fails. This is necessary in some setups
1162 // when user is over quota and Trash is included in the quota.
acc005 1163 $config['delete_always'] = false;
b7f952 1164
1b30a7 1165 // Directly delete messages in Junk instead of moving to Trash
acc005 1166 $config['delete_junk'] = false;
1b30a7 1167
f22ea7 1168 // Behavior if a received message requests a message delivery notification (read receipt)
A 1169 // 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask)
1170 // 3 = send automatically if sender is in addressbook, otherwise ask the user
1171 // 4 = send automatically if sender is in addressbook, otherwise ignore
acc005 1172 $config['mdn_requests'] = 0;
b25dfd 1173
f22ea7 1174 // Return receipt checkbox default state
acc005 1175 $config['mdn_default'] = 0;
f22ea7 1176
A 1177 // Delivery Status Notification checkbox default state
f1fba2 1178 // Note: This can be used only if smtp_server is non-empty
acc005 1179 $config['dsn_default'] = 0;
f22ea7 1180
eeb85f 1181 // Place replies in the folder of the message being replied to
acc005 1182 $config['reply_same_folder'] = false;
eeb85f 1183
a509bb 1184 // Sets default mode of Forward feature to "forward as attachment"
acc005 1185 $config['forward_attachment'] = false;
a509bb 1186
d73448 1187 // Defines address book (internal index) to which new contacts will be added
A 1188 // By default it is the first writeable addressbook.
1189 // Note: Use '0' for built-in address book.
acc005 1190 $config['default_addressbook'] = null;
d73448 1191
1d5779 1192 // Enables spell checking before sending a message.
acc005 1193 $config['spellcheck_before_send'] = false;
1d5779 1194
710b1b 1195 // Skip alternative email addresses in autocompletion (show one address per contact)
acc005 1196 $config['autocomplete_single'] = false;
710b1b 1197
7e263e 1198 // Default font for composed HTML message.
A 1199 // Supported values: Andale Mono, Arial, Arial Black, Book Antiqua, Courier New,
1200 // Georgia, Helvetica, Impact, Tahoma, Terminal, Times New Roman, Trebuchet MS, Verdana
acc005 1201 $config['default_font'] = 'Verdana';
7e263e 1202
7dff44 1203 // Default font size for composed HTML message.
D 1204 // Supported sizes: 8pt, 10pt, 12pt, 14pt, 18pt, 24pt, 36pt
189958 1205 $config['default_font_size'] = '10pt';
7dff44 1206
969cb0 1207 // Enables display of email address with name instead of a name (and address in title)
acc005 1208 $config['message_show_email'] = false;
b972b4 1209
AM 1210 // Default behavior of Reply-All button:
1211 // 0 - Reply-All always
1212 // 1 - Reply-List if mailing list is detected
1213 $config['reply_all_mode'] = 0;