Aleksander Machniak
2013-07-02 ed3e51f1b41d818ae757220fd41cdf0b093b20f6
commit | author | age
4e17e6 1 <?php
T 2
3 /*
4  +-----------------------------------------------------------------------+
5  | Main configuration file                                               |
6  |                                                                       |
e019f2 7  | This file is part of the Roundcube Webmail client                     |
62c861 8  | Copyright (C) 2005-2011, 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
16 */
17
18 $rcmail_config = array();
19
2d08c5 20 // ----------------------------------
A 21 // LOGGING/DEBUGGING
22 // ----------------------------------
23
e077c1 24 // system error reporting, sum of: 1 = log; 4 = show, 8 = trace
13c1af 25 $rcmail_config['debug_level'] = 1;
4e17e6 26
b77d0d 27 // log driver:  'syslog' or 'file'.
A 28 $rcmail_config['log_driver'] = 'file';
29
0ad27c 30 // date format for log entries
A 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
b77d0d 34 // Syslog ident string to use, if using the 'syslog' log driver.
A 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
3e3429 41 // Log sent messages to <log_dir>/sendmail or to syslog
2d08c5 42 $rcmail_config['smtp_log'] = true;
b77d0d 43
3e3429 44 // Log successful logins to <log_dir>/userlogins or to syslog
2d08c5 45 $rcmail_config['log_logins'] = false;
b77d0d 46
fcc7f8 47 // Log session authentication errors to <log_dir>/session or to syslog
T 48 $rcmail_config['log_session'] = false;
49
2d08c5 50 // Log SQL queries to <log_dir>/sql or to syslog
A 51 $rcmail_config['sql_debug'] = false;
cc97ea 52
2d08c5 53 // Log IMAP conversation to <log_dir>/imap or to syslog
A 54 $rcmail_config['imap_debug'] = false;
6dc026 55
2d08c5 56 // Log LDAP conversation to <log_dir>/ldap or to syslog
A 57 $rcmail_config['ldap_debug'] = false;
cc9570 58
2d08c5 59 // Log SMTP conversation to <log_dir>/smtp or to syslog
A 60 $rcmail_config['smtp_debug'] = false;
f5d61d 61
2d08c5 62 // ----------------------------------
A 63 // IMAP
64 // ----------------------------------
4e17e6 65
768e33 66 // The mail host chosen to perform the log-in.
AM 67 // Leave blank to show a textbox at login, give a list of hosts
42b113 68 // to display a pulldown menu or set one host as string.
f86e8f 69 // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
bb8721 70 // Supported replacement variables:
d359dc 71 // %n - hostname ($_SERVER['SERVER_NAME'])
B 72 // %t - hostname without the first part
73 // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
b04c51 74 // %s - domain name after the '@' from e-mail address provided at login screen
d359dc 75 // For example %n = mail.domain.tld, %t = domain.tld
768e33 76 // WARNING: After hostname change update of mail_host column in users table is
AM 77 //          required to match old user data records with the new host.
4e17e6 78 $rcmail_config['default_host'] = '';
T 79
42b113 80 // TCP port used for IMAP connections
T 81 $rcmail_config['default_port'] = 143;
82
00f347 83 // IMAP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or null to use
4dd417 84 // best server supported one)
b026c3 85 $rcmail_config['imap_auth_type'] = null;
T 86
00290a 87 // If you know your imap's folder delimiter, you can specify it here.
A 88 // Otherwise it will be determined automatically
030c84 89 $rcmail_config['imap_delimiter'] = null;
A 90
00290a 91 // If IMAP server doesn't support NAMESPACE extension, but you're
A 92 // using shared folders or personal root folder is non-empty, you'll need to
93 // set these options. All can be strings or arrays of strings.
e3af1f 94 // Folders need to be ended with directory separator, e.g. "INBOX."
A 95 // (special directory "~" is an exception to this rule)
02491a 96 // These can be used also to overwrite server's namespaces
00290a 97 $rcmail_config['imap_ns_personal'] = null;
A 98 $rcmail_config['imap_ns_other']    = null;
99 $rcmail_config['imap_ns_shared']   = null;
100
d8c440 101 // By default IMAP capabilities are readed after connection to IMAP server
A 102 // In some cases, e.g. when using IMAP proxy, there's a need to refresh the list
103 // after login. Set to True if you've got this case.
104 $rcmail_config['imap_force_caps'] = false;
105
f75f65 106 // By default list of subscribed folders is determined using LIST-EXTENDED
A 107 // extension if available. Some servers (dovecot 1.x) returns wrong results
108 // for shared namespaces in this case. http://trac.roundcube.net/ticket/1486225
109 // Enable this option to force LSUB command usage instead.
ed3e51 110 // Deprecated: Use imap_disabled_caps = array('LIST-EXTENDED')
f75f65 111 $rcmail_config['imap_force_lsub'] = false;
A 112
3c5489 113 // Some server configurations (e.g. Courier) doesn't list folders in all namespaces
AM 114 // Enable this option to force listing of folders in all namespaces
115 $rcmail_config['imap_force_ns'] = false;
116
ed3e51 117 // List of disabled imap extensions.
AM 118 // Use if your IMAP server has broken implementation of some feature
119 // and you can't remove it from CAPABILITY string on server-side.
120 // For example UW-IMAP server has broken ESEARCH.
121 // Note: Because the list is cached, re-login is required after change.
122 $rcmail_config['imap_disabled_caps'] = array();
123
f07d23 124 // IMAP connection timeout, in seconds. Default: 0 (no limit)
A 125 $rcmail_config['imap_timeout'] = 0;
126
a1fe6b 127 // Optional IMAP authentication identifier to be used as authorization proxy
A 128 $rcmail_config['imap_auth_cid'] = null;
129
130 // Optional IMAP authentication password to be used for imap_auth_cid
131 $rcmail_config['imap_auth_pw'] = null;
132
8edb3d 133 // Type of IMAP indexes cache. Supported values: 'db', 'apc' and 'memcache'.
5cf5ee 134 $rcmail_config['imap_cache'] = null;
A 135
136 // Enables messages cache. Only 'db' cache is supported.
137 $rcmail_config['messages_cache'] = false;
138
61ccdf 139 // Lifetime of IMAP indexes cache. Possible units: s, m, h, d, w
AM 140 $rcmail_config['imap_cache_ttl'] = '10d';
141
67ac6e 142 // Lifetime of messages cache. Possible units: s, m, h, d, w
AM 143 $rcmail_config['messages_cache_ttl'] = '10d';
5cf5ee 144
2d08c5 145 // ----------------------------------
A 146 // SMTP
147 // ----------------------------------
f88d41 148
c3b676 149 // SMTP server host (for sending mails).
2d08c5 150 // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
c3b676 151 // If left blank, the PHP mail() function is used
bb8721 152 // Supported replacement variables:
A 153 // %h - user's IMAP hostname
d359dc 154 // %n - hostname ($_SERVER['SERVER_NAME'])
B 155 // %t - hostname without the first part
156 // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
11be93 157 // %z - IMAP domain (IMAP hostname without the first part)
d359dc 158 // For example %n = mail.domain.tld, %t = domain.tld
4e17e6 159 $rcmail_config['smtp_server'] = '';
T 160
e52aae 161 // SMTP port (default is 25; use 587 for STARTTLS or 465 for the
T 162 // deprecated SSL over SMTP (aka SMTPS))
968bdc 163 $rcmail_config['smtp_port'] = 25;
T 164
e019f2 165 // SMTP username (if required) if you use %u as the username Roundcube
d206c1 166 // will use the current username for login
4e17e6 167 $rcmail_config['smtp_user'] = '';
T 168
e019f2 169 // SMTP password (if required) if you use %p as the password Roundcube
d206c1 170 // will use the current user's password for login
4e17e6 171 $rcmail_config['smtp_pass'] = '';
T 172
d206c1 173 // SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
S 174 // best server supported one)
175 $rcmail_config['smtp_auth_type'] = '';
176
63d4d6 177 // Optional SMTP authentication identifier to be used as authorization proxy
A 178 $rcmail_config['smtp_auth_cid'] = null;
179
a1fe6b 180 // Optional SMTP authentication password to be used for smtp_auth_cid
63d4d6 181 $rcmail_config['smtp_auth_pw'] = null;
a39212 182
aca3d2 183 // SMTP HELO host 
S 184 // Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages 
185 // Leave this blank and you will get the server variable 'server_name' or 
b07426 186 // localhost if that isn't defined.
aca3d2 187 $rcmail_config['smtp_helo_host'] = '';
S 188
f07d23 189 // SMTP connection timeout, in seconds. Default: 0 (no limit)
cd9e41 190 // Note: There's a known issue where using ssl connection with
AM 191 // timeout > 0 causes connection errors (https://bugs.php.net/bug.php?id=54511)
f07d23 192 $rcmail_config['smtp_timeout'] = 0;
b07426 193
AM 194 // ----------------------------------
195 // LDAP
196 // ----------------------------------
197
198 // Type of LDAP cache. Supported values: 'db', 'apc' and 'memcache'.
199 $rcmail_config['ldap_cache'] = 'db';
200
201 // Lifetime of LDAP cache. Possible units: s, m, h, d, w
202 $rcmail_config['ldap_cache_ttl'] = '10m';
f07d23 203
2d08c5 204 // ----------------------------------
A 205 // SYSTEM
206 // ----------------------------------
64608b 207
2d08c5 208 // THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA.
A 209 // ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING!
210 $rcmail_config['enable_installer'] = false;
4e17e6 211
e04e31 212 // don't allow these settings to be overriden by the user
AM 213 $rcmail_config['dont_override'] = array();
214
c04b23 215 // provide an URL where a user can get support for this Roundcube installation
T 216 // PLEASE DO NOT LINK TO THE ROUNDCUBE.NET WEBSITE HERE!
217 $rcmail_config['support_url'] = '';
218
219 // replace Roundcube logo with this image
220 // specify an URL relative to the document root of this Roundcube installation
221 $rcmail_config['skin_logo'] = null;
222
223 // automatically create a new Roundcube user when log-in the first time.
224 // a new user will be created once the IMAP login succeeds.
225 // set to false if only registered users can use this service
226 $rcmail_config['auto_create_user'] = true;
227
565c47 228 // Enables possibility to log in using email address from user identities
AM 229 $rcmail_config['user_aliases'] = false;
230
2d08c5 231 // use this folder to store log files (must be writeable for apache user)
A 232 // This is used by the 'file' log driver.
233 $rcmail_config['log_dir'] = 'logs/';
d559cb 234
2d08c5 235 // use this folder to store temp files (must be writeable for apache user)
A 236 $rcmail_config['temp_dir'] = 'temp/';
19862b 237
2d08c5 238 // enforce connections over https
A 239 // with this option enabled, all non-secure connections will be redirected.
240 // set the port for the ssl connection as value of this option if it differs from the default 443
241 $rcmail_config['force_https'] = false;
acb08f 242
00e18b 243 // tell PHP that it should work as under secure connection
A 244 // even if it doesn't recognize it as secure ($_SERVER['HTTPS'] is not set)
245 // e.g. when you're running Roundcube behind a https proxy
377bc6 246 // this option is mutually exclusive to 'force_https' and only either one of them should be set to true.
00e18b 247 $rcmail_config['use_https'] = false;
A 248
1cca4f 249 // Allow browser-autocompletion on login form.
A 250 // 0 - disabled, 1 - username and host only, 2 - username, host, password
251 $rcmail_config['login_autocomplete'] = 0;
fbe24e 252
c72325 253 // Forces conversion of logins to lower case.
AM 254 // 0 - disabled, 1 - only domain part, 2 - domain and local part.
df95e7 255 // If users authentication is case-insensitive this must be enabled.
AM 256 // Note: After enabling it all user records need to be updated, e.g. with query:
257 //       UPDATE users SET username = LOWER(username);
258 $rcmail_config['login_lc'] = 2;
ae39c4 259
95d90f 260 // Includes should be interpreted as PHP files
2d08c5 261 $rcmail_config['skin_include_php'] = false;
fd8c50 262
b6267d 263 // display software version on login screen
TB 264 $rcmail_config['display_version'] = false;
265
95d90f 266 // Session lifetime in minutes
7902df 267 $rcmail_config['session_lifetime'] = 10;
T 268
ae7027 269 // Session domain: .example.org
cf2da2 270 $rcmail_config['session_domain'] = '';
T 271
ae7027 272 // Session name. Default: 'roundcube_sessid'
bd34ca 273 $rcmail_config['session_name'] = null;
A 274
ae7027 275 // Session path. Defaults to PHP session.cookie_path setting.
AM 276 $rcmail_config['session_path'] = null;
277
42de33 278 // Backend to use for session storage. Can either be 'db' (default), 'memcache' or 'php'
TB 279 // If set to 'memcache', a list of servers need to be specified in 'memcache_hosts'
63e992 280 // Make sure the Memcache extension (http://pecl.php.net/package/memcache) version >= 2.0.0 is installed
42de33 281 // Setting this value to 'php' will use the default session save handler configured in PHP
63e992 282 $rcmail_config['session_storage'] = 'db';
T 283
284 // Use these hosts for accessing memcached
71ee56 285 // Define any number of hosts in the form of hostname:port or unix:///path/to/socket.file
AM 286 $rcmail_config['memcache_hosts'] = null; // e.g. array( 'localhost:11211', '192.168.1.12:11211', 'unix:///var/tmp/memcached.sock' );
63e992 287
4e17e6 288 // check client IP in session athorization
aad6e2 289 $rcmail_config['ip_check'] = false;
4e17e6 290
a77cf2 291 // check referer of incoming requests
T 292 $rcmail_config['referer_check'] = false;
293
c170bf 294 // X-Frame-Options HTTP header value sent to prevent from Clickjacking.
T 295 // Possible values: sameorigin|deny. Set to false in order to disable sending them
67eecd 296 $rcmail_config['x_frame_options'] = 'sameorigin';
c170bf 297
bac7d1 298 // this key is used to encrypt the users imap password which is stored
T 299 // in the session record (and the client cookie if remember password is enabled).
300 // please provide a string of exactly 24 chars.
301 $rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str';
302
2d08c5 303 // Automatically add this domain to user names for login
A 304 // Only for IMAP servers that require full e-mail addresses for login
305 // Specify an array with 'host' => 'domain' values to support multiple hosts
6a642d 306 // Supported replacement variables:
A 307 // %h - user's IMAP hostname
d359dc 308 // %n - hostname ($_SERVER['SERVER_NAME'])
B 309 // %t - hostname without the first part
310 // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
11be93 311 // %z - IMAP domain (IMAP hostname without the first part)
d359dc 312 // For example %n = mail.domain.tld, %t = domain.tld
2d08c5 313 $rcmail_config['username_domain'] = '';
A 314
315 // This domain will be used to form e-mail addresses of new users
316 // Specify an array with 'host' => 'domain' values to support multiple hosts
bb8721 317 // Supported replacement variables:
A 318 // %h - user's IMAP hostname
319 // %n - http hostname ($_SERVER['SERVER_NAME'])
320 // %d - domain (http hostname without the first part)
11be93 321 // %z - IMAP domain (IMAP hostname without the first part)
d359dc 322 // For example %n = mail.domain.tld, %t = domain.tld
2d08c5 323 $rcmail_config['mail_domain'] = '';
A 324
325 // Password charset.
326 // Use it if your authentication backend doesn't support UTF-8.
327 // Defaults to ISO-8859-1 for backward compatibility
328 $rcmail_config['password_charset'] = 'ISO-8859-1';
329
330 // How many seconds must pass between emails sent by a user
331 $rcmail_config['sendmail_delay'] = 0;
332
751b22 333 // Maximum number of recipients per message. Default: 0 (no limit)
A 334 $rcmail_config['max_recipients'] = 0; 
335
d1851b 336 // Maximum allowednumber of members of an address group. Default: 0 (no limit)
T 337 // If 'max_recipients' is set this value should be less or equal
338 $rcmail_config['max_group_members'] = 0; 
339
2d08c5 340 // add this user-agent to message headers when sending
6b6f2e 341 $rcmail_config['useragent'] = 'Roundcube Webmail/'.RCMAIL_VERSION;
2d08c5 342
A 343 // use this name to compose page titles
6b6f2e 344 $rcmail_config['product_name'] = 'Roundcube Webmail';
2d08c5 345
A 346 // try to load host-specific configuration
347 // see http://trac.roundcube.net/wiki/Howto_Config for more details
348 $rcmail_config['include_host_config'] = false;
349
350 // path to a text file which will be added to each sent message
e019f2 351 // paths are relative to the Roundcube root folder
2d08c5 352 $rcmail_config['generic_message_footer'] = '';
A 353
5852c1 354 // path to a text file which will be added to each sent HTML message
e019f2 355 // paths are relative to the Roundcube root folder
5852c1 356 $rcmail_config['generic_message_footer_html'] = '';
A 357
2d08c5 358 // add a received header to outgoing mails containing the creators IP and hostname
A 359 $rcmail_config['http_received_header'] = false;
360
361 // Whether or not to encrypt the IP address and the host name
362 // these could, in some circles, be considered as sensitive information;
363 // however, for the administrator, these could be invaluable help
364 // when tracking down issues.
365 $rcmail_config['http_received_header_encrypt'] = false;
366
ac8edb 367 // This string is used as a delimiter for message headers when sending
A 368 // a message via mail() function. Leave empty for auto-detection
2d08c5 369 $rcmail_config['mail_header_delimiter'] = NULL;
A 370
6b6f2e 371 // number of chars allowed for line when wrapping text.
T 372 // text wrapping is done when composing/sending messages
c769c6 373 $rcmail_config['line_length'] = 72;
6b6f2e 374
T 375 // send plaintext messages as format=flowed
376 $rcmail_config['send_format_flowed'] = true;
2d08c5 377
232535 378 // According to RFC2298, return receipt envelope sender address must be empty.
AM 379 // If this option is true, Roundcube will use user's identity as envelope sender for MDN responses.
380 $rcmail_config['mdn_use_from'] = false;
381
2d08c5 382 // Set identities access level:
A 383 // 0 - many identities with possibility to edit all params
384 // 1 - many identities with possibility to edit all params but not email address
385 // 2 - one identity with possibility to edit all params
386 // 3 - one identity with possibility to edit all params but not email address
f12585 387 // 4 - one identity with possibility to edit only signature
2d08c5 388 $rcmail_config['identities_level'] = 0;
A 389
f7b58a 390 // Mimetypes supported by the browser.
T 391 // attachments of these types will open in a preview window
392 // either a comma-separated list or an array: 'text/plain,text/html,text/xml,image/jpeg,image/gif,image/png,application/pdf'
393 $rcmail_config['client_mimetypes'] = null;  # null == default
394
0a8397 395 // Path to a local mime magic database file for PHPs finfo extension.
TB 396 // Set to null if the default path should be used.
397 $rcmail_config['mime_magic'] = null;
398
9e1605 399 // Absolute path to a local mime.types mapping table file.
0a8397 400 // This is used to derive mime-types from the filename extension or vice versa.
9e1605 401 // Such a file is usually part of the apache webserver. If you don't find a file named mime.types on your system,
TB 402 // download it from http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types
0a8397 403 $rcmail_config['mime_types'] = null;
2d08c5 404
0501b6 405 // path to imagemagick identify binary
T 406 $rcmail_config['im_identify_path'] = null;
407
408 // path to imagemagick convert binary
409 $rcmail_config['im_convert_path'] = null;
410
031491 411 // Size of thumbnails from image attachments displayed below the message content.
TB 412 // Note: whether images are displayed at all depends on the 'inline_images' option.
413 // Set to 0 to display images in full size.
414 $rcmail_config['image_thumbnail_size'] = 240;
415
0501b6 416 // maximum size of uploaded contact photos in pixel
T 417 $rcmail_config['contact_photo_size'] = 160;
418
2d08c5 419 // Enable DNS checking for e-mail address validation
A 420 $rcmail_config['email_dns_check'] = false;
421
e04e31 422 // Disables saving sent messages in Sent folder (like gmail) (Default: false)
AM 423 // Note: useful when SMTP server stores sent mail in user mailbox
424 $rcmail_config['no_save_sent_messages'] = false;
425
2d08c5 426 // ----------------------------------
A 427 // PLUGINS
428 // ----------------------------------
429
430 // List of active plugins (in plugins/ directory)
431 $rcmail_config['plugins'] = array();
432
433 // ----------------------------------
434 // USER INTERFACE
435 // ----------------------------------
436
f52c93 437 // default messages sort column. Use empty value for default server's sorting, 
e0efd8 438 // or 'arrival', 'date', 'subject', 'from', 'to', 'fromto', 'size', 'cc'
f52c93 439 $rcmail_config['message_sort_col'] = '';
2d08c5 440
f52c93 441 // default messages sort order
2d08c5 442 $rcmail_config['message_sort_order'] = 'DESC';
A 443
444 // These cols are shown in the message list. Available cols are:
e0efd8 445 // subject, from, to, fromto, cc, replyto, date, size, status, flag, attachment, 'priority'
AM 446 $rcmail_config['list_cols'] = array('subject', 'status', 'fromto', 'date', 'size', 'flag', 'attachment');
2d08c5 447
c8ae24 448 // the default locale setting (leave empty for auto-detection)
T 449 // RFC1766 formatted language name like en_US, de_DE, de_CH, fr_FR, pt_BR
450 $rcmail_config['language'] = null;
4e17e6 451
1cc9e2 452 // use this format for date display (date or strftime format)
T 453 $rcmail_config['date_format'] = 'Y-m-d';
454
455 // give this choice of date formats to the user to select from
456 $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');
457
458 // use this format for time display (date or strftime format)
459 $rcmail_config['time_format'] = 'H:i';
460
461 // give this choice of time formats to the user to select from
462 $rcmail_config['time_formats'] = array('G:i', 'H:i', 'g:i a', 'h:i A');
463
464 // use this format for short date display (derived from date_format and time_format)
4e17e6 465 $rcmail_config['date_short'] = 'D H:i';
T 466
1cc9e2 467 // use this format for detailed date/time formatting (derived from date_format and time_format)
T 468 $rcmail_config['date_long'] = 'Y-m-d H:i';
4e17e6 469
1966c5 470 // store draft message is this mailbox
S 471 // leave blank if draft messages should not be stored
d08333 472 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
1966c5 473 $rcmail_config['drafts_mbox'] = 'Drafts';
S 474
b4b081 475 // store spam messages in this mailbox
d08333 476 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
b4b081 477 $rcmail_config['junk_mbox'] = 'Junk';
S 478
4e17e6 479 // store sent message is this mailbox
T 480 // leave blank if sent messages should not be stored
d08333 481 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
4e17e6 482 $rcmail_config['sent_mbox'] = 'Sent';
T 483
484 // move messages to this folder when deleting them
485 // leave blank if they should be deleted directly
d08333 486 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
4e17e6 487 $rcmail_config['trash_mbox'] = 'Trash';
T 488
fa4cd2 489 // display these folders separately in the mailbox list.
83ce4b 490 // these folders will also be displayed with localized names
d08333 491 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
bf9dde 492 $rcmail_config['default_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash');
4e17e6 493
85e65c 494 // Disable localization of the default folder names listed above
149f8a 495 $rcmail_config['show_real_foldernames'] = false;
52deb1 496
95ebcd 497 // automatically create the above listed default folders on first login
2d08c5 498 $rcmail_config['create_default_folders'] = false;
b2ff3d 499
c8c1e0 500 // protect the default folders from renames, deletes, and subscription changes
2d08c5 501 $rcmail_config['protect_default_folders'] = true;
c8c1e0 502
2d08c5 503 // if in your system 0 quota means no limit set this option to true 
A 504 $rcmail_config['quota_zero_as_unlimited'] = false;
876b15 505
996066 506 // Make use of the built-in spell checker. It is based on GoogieSpell.
e9ac14 507 // Since Google only accepts connections over https your PHP installatation
T 508 // requires to be compiled with Open SSL support
2d08c5 509 $rcmail_config['enable_spellcheck'] = true;
ed5d29 510
66df08 511 // Enables spellchecker exceptions dictionary.
A 512 // Setting it to 'shared' will make the dictionary shared by all users.
513 $rcmail_config['spellcheck_dictionary'] = false;
514
5d2b7f 515 // Set the spell checking engine. 'googie' is the default. 'pspell' is also available,
T 516 // but requires the Pspell extensions. When using Nox Spell Server, also set 'googie' here.
517 $rcmail_config['spellcheck_engine'] = 'googie';
518
996066 519 // For a locally installed Nox Spell Server, please specify the URI to call it.
T 520 // Get Nox Spell Server from http://orangoo.com/labs/?page_id=72
521 // Leave empty to use the Google spell checking service, what means
522 // that the message content will be sent to Google in order to check spelling
523 $rcmail_config['spellcheck_uri'] = '';
524
525 // These languages can be selected for spell checking.
526 // Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch');
01a8c5 527 // Leave empty for default set of available language.
996066 528 $rcmail_config['spellcheck_languages'] = NULL;
T 529
66df08 530 // Makes that words with all letters capitalized will be ignored (e.g. GOOGLE)
A 531 $rcmail_config['spellcheck_ignore_caps'] = false;
532
533 // Makes that words with numbers will be ignored (e.g. g00gle)
534 $rcmail_config['spellcheck_ignore_nums'] = false;
535
536 // Makes that words with symbols will be ignored (e.g. g@@gle)
537 $rcmail_config['spellcheck_ignore_syms'] = false;
538
62c861 539 // Use this char/string to separate recipients when composing a new message
T 540 $rcmail_config['recipients_separator'] = ',';
541
2d08c5 542 // don't let users set pagesize to more than this value if set
A 543 $rcmail_config['max_pagesize'] = 200;
967b34 544
f22654 545 // Minimal value of user's 'refresh_interval' setting (in seconds)
AM 546 $rcmail_config['min_refresh_interval'] = 60;
2471d3 547
4171c5 548 // Enables files upload indicator. Requires APC installed and enabled apc.rfc1867 option.
A 549 // By default refresh time is set to 1 second. You can set this value to true
550 // or any integer value indicating number of seconds.
551 $rcmail_config['upload_progress'] = false;
552
63fda8 553 // Specifies for how many seconds the Undo button will be available
A 554 // after object delete action. Currently used with supporting address book sources.
555 // Setting it to 0, disables the feature.
556 $rcmail_config['undo_timeout'] = 0;
557
2d08c5 558 // ----------------------------------
A 559 // ADDRESSBOOK SETTINGS
560 // ----------------------------------
aec82b 561
6153e2 562 // This indicates which type of address book to use. Possible choises:
5526f9 563 // 'sql' (default), 'ldap' and ''.
6153e2 564 // If set to 'ldap' then it will look at using the first writable LDAP
4f9c83 565 // address book as the primary address book and it will not display the
S 566 // SQL address book in the 'Address Book' view.
5526f9 567 // If set to '' then no address book will be displayed or only the
JD 568 // addressbook which is created by a plugin (like CardDAV).
6153e2 569 $rcmail_config['address_book_type'] = 'sql';
4f9c83 570
S 571 // In order to enable public ldap search, configure an array like the Verisign
572 // example further below. if you would like to test, simply uncomment the example.
ecf295 573 // Array key must contain only safe characters, ie. a-zA-Z0-9_
5f25a1 574 $rcmail_config['ldap_public'] = array();
T 575
4f9c83 576 // If you are going to use LDAP for individual address books, you will need to 
S 577 // set 'user_specific' to true and use the variables to generate the appropriate DNs to access it.
578 //
579 // The recommended directory structure for LDAP is to store all the address book entries
580 // under the users main entry, e.g.:
581 //
582 //  o=root
583 //   ou=people
584 //    uid=user@domain
3b9a53 585 //  mail=contact@contactdomain
T 586 //
4f9c83 587 // So the base_dn would be uid=%fu,ou=people,o=root
S 588 // The bind_dn would be the same as based_dn or some super user login.
3b9a53 589 /* 
f11541 590  * example config for Verisign directory
eea43f 591  *
3b9a53 592 $rcmail_config['ldap_public']['Verisign'] = array(
T 593   'name'          => 'Verisign.com',
bb8721 594   // Replacement variables supported in host names:
A 595   // %h - user's IMAP hostname
d359dc 596   // %n - hostname ($_SERVER['SERVER_NAME'])
B 597   // %t - hostname without the first part
598   // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
11be93 599   // %z - IMAP domain (IMAP hostname without the first part)
d359dc 600   // For example %n = mail.domain.tld, %t = domain.tld
3b9a53 601   'hosts'         => array('directory.verisign.com'),
T 602   'port'          => 389,
c64bee 603   'use_tls'       => false,
0c5210 604   'ldap_version'  => 3,       // using LDAPv3
e114a6 605   '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 606   'user_specific' => false,   // If true the base_dn, bind_dn and bind_pass default to the user's IMAP login.
T 607   // %fu - The full username provided, assumes the username is an email
608   //       address, uses the username_domain value if not an email address.
609   // %u  - The username prior to the '@'.
610   // %d  - The domain name after the '@'.
f76765 611   // %dc - The domain name hierarchal string e.g. "dc=test,dc=domain,dc=com"
1148c6 612   // %dn - DN found by ldap search when search_filter/search_base_dn are used
3b9a53 613   'base_dn'       => '',
T 614   'bind_dn'       => '',
615   'bind_pass'     => '',
1148c6 616   // It's possible to bind for an individual address book
A 617   // The login name is used to search for the DN to bind with
618   'search_base_dn' => '',
619   'search_filter'  => '',   // e.g. '(&(objectClass=posixAccount)(uid=%u))'
2d08ec 620   // DN and password to bind as before searching for bind DN, if anonymous search is not allowed
A 621   'search_bind_dn' => '',
622   'search_bind_pw' => '',
c041d5 623   // Default for %dn variable if search doesn't return DN value
A 624   'search_dn_default' => '',
4d982d 625   // Optional authentication identifier to be used as SASL authorization proxy
A 626   // bind_dn need to be empty
627   'auth_cid'       => '',
628   // SASL authentication method (for proxy auth), e.g. DIGEST-MD5
629   'auth_method'    => '',
2d3e2b 630   // Indicates if the addressbook shall be hidden from the list.
5c9d1f 631   // With this option enabled you can still search/view contacts.
A 632   'hidden'        => false,
2d3e2b 633   // Indicates if the addressbook shall not list contacts but only allows searching.
T 634   'searchonly'    => false,
0c5210 635   // Indicates if we can write to the LDAP directory or not.
3b9a53 636   // If writable is true then these fields need to be populated:
T 637   // LDAP_Object_Classes, required_fields, LDAP_rdn
0c5210 638   'writable'       => false,
A 639   // To create a new contact these are the object classes to specify
640   // (or any other classes you wish to use).
641   'LDAP_Object_Classes' => array('top', 'inetOrgPerson'),
642   // The RDN field that is used for new entries, this field needs
643   // to be one of the search_fields, the base of base_dn is appended
644   // to the RDN to insert into the LDAP directory.
ca3d76 645   'LDAP_rdn'       => 'cn',
0c5210 646   // The required fields needed to build a new contact as required by
A 647   // the object classes (can include additional fields not required by the object classes).
648   'required_fields' => array('cn', 'sn', 'mail'),
649   'search_fields'   => array('mail', 'cn'),  // fields to search in
650   // mapping of contact fields to directory attributes
a605b2 651   //   for every attribute one can specify the number of values (limit) allowed.
T 652   //   default is 1, a wildcard * means unlimited
0c5210 653   'fieldmap' => array(
a605b2 654     // Roundcube  => LDAP:limit
0501b6 655     'name'        => 'cn',
T 656     'surname'     => 'sn',
657     'firstname'   => 'givenName',
b2c3c3 658     'jobtitle'    => 'title',
a605b2 659     'email'       => 'mail:*',
0501b6 660     'phone:home'  => 'homePhone',
T 661     'phone:work'  => 'telephoneNumber',
662     'phone:mobile' => 'mobile',
ca3d76 663     'phone:pager' => 'pager',
e43cc4 664     'phone:workfax' => 'facsimileTelephoneNumber',
0501b6 665     'street'      => 'street',
T 666     'zipcode'     => 'postalCode',
ca3d76 667     'region'      => 'st',
0501b6 668     'locality'    => 'l',
a605b2 669     // if you country is a complex object, you need to configure 'sub_fields' below
T 670     'country'      => 'c',
b563fc 671     'organization' => 'o',
a605b2 672     'department'   => 'ou',
T 673     'jobtitle'     => 'title',
674     'notes'        => 'description',
e43cc4 675     'photo'        => 'jpegPhoto',
a605b2 676     // these currently don't work:
T 677     // 'manager'       => 'manager',
678     // 'assistant'     => 'secretary',
0501b6 679   ),
a605b2 680   // Map of contact sub-objects (attribute name => objectClass(es)), e.g. 'c' => 'country'
T 681   'sub_fields' => array(),
3f250a 682   // Generate values for the following LDAP attributes automatically when creating a new record
TB 683   'autovalues' => array(
684   // 'uid'  => 'md5(microtime())',               // You may specify PHP code snippets which are then eval'ed 
685   // 'mail' => '{givenname}.{sn}@mydomain.com',  // or composite strings with placeholders for existing attributes
686   ),
a6d418 687   'sort'           => 'cn',         // The field to sort the listing by.
TB 688   'scope'          => 'sub',        // search mode: sub|base|list
689   'filter'         => '(objectClass=inetOrgPerson)',      // used for basic listing (if not empty) and will be &'d with search queries. example: status=act
690   'fuzzy_search'   => true,         // server allows wildcard search
691   'vlv'            => false,        // Enable Virtual List View to more efficiently fetch paginated data (if server supports it)
692   'vlv_search'     => false,        // Use Virtual List View functions for autocompletion searches (if server supports it)
693   '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
694   'config_root_dn' => 'cn=config',  // Root DN to search config entries (e.g. vlv indexes)
695   'sizelimit'      => '0',          // Enables you to limit the count of entries fetched. Setting this to 0 means no limit.
696   'timelimit'      => '0',          // Sets the number of seconds how long is spend on the search. Setting this to 0 means no limit.
697   'referrals'      => false,        // Sets the LDAP_OPT_REFERRALS option. Mostly used in multi-domain Active Directory setups
d1e08f 698
T 699   // definition for contact groups (uncomment if no groups are supported)
700   // for the groups base_dn, the user replacements %fu, %u, $d and %dc work as for base_dn (see above)
701   // if the groups base_dn is empty, the contact base_dn is used for the groups as well
15d762 702   // -> in this case, assure that groups and contacts are separated due to the concernig filters! 
a6d418 703   'groups'  => array(
TB 704     'base_dn'        => '',
705     'scope'          => 'sub',       // Search mode: sub|base|list
706     'filter'         => '(objectClass=groupOfNames)',
d1e08f 707     'object_classes' => array("top", "groupOfNames"),
a6d418 708     'member_attr'    => 'member',   // Name of the member attribute, e.g. uniqueMember
TB 709     'name_attr'      => 'cn',       // Attribute to be used as group name
710     'member_filter'  => '(objectclass=*)',  // Optional filter to use when querying for group members
711     'vlv'            => false,      // Use VLV controls to list groups
6039aa 712   ),
e43cc4 713   // this configuration replaces the regular groups listing in the directory tree with
TB 714   // a hard-coded list of groups, each listing entries with the configured base DN and filter.
715   // if the 'groups' option from above is set, it'll be shown as the first entry with the name 'Groups'
716   'group_filters' => array(
717     'departments' => array(
718       'name'    => 'Company Departments',
719       'scope'   => 'list',
720       'base_dn' => 'ou=Groups,dc=mydomain,dc=com',
721       'filter'  => '(|(objectclass=groupofuniquenames)(objectclass=groupofurls))',
9eaf68 722       'name_attr' => 'cn',
e43cc4 723     ),
TB 724     'customers' => array(
725       'name'    => 'Customers',
726       'scope'   => 'sub',
727       'base_dn' => 'ou=Customers,dc=mydomain,dc=com',
728       'filter'  => '(objectClass=inetOrgPerson)',
9eaf68 729       'name_attr' => 'sn',
e43cc4 730     ),
2c8e84 731   ),
T 732 );
733 */
c296b8 734
A 735 // An ordered array of the ids of the addressbooks that should be searched
736 // when populating address autocomplete fields server-side. ex: array('sql','Verisign');
737 $rcmail_config['autocomplete_addressbooks'] = array('sql');
738
0501b6 739 // The minimum number of characters required to be typed in an autocomplete field
T 740 // before address books will be searched. Most useful for LDAP directories that
741 // may need to do lengthy results building given overly-broad searches
742 $rcmail_config['autocomplete_min_length'] = 1;
2d08c5 743
0213f8 744 // Number of parallel autocomplete requests.
A 745 // If there's more than one address book, n parallel (async) requests will be created,
746 // where each request will search in one address book. By default (0), all address
747 // books are searched in one request.
748 $rcmail_config['autocomplete_threads'] = 0;
749
750 // Max. numer of entries in autocomplete popup. Default: 15.
751 $rcmail_config['autocomplete_max'] = 15;
752
2a4135 753 // show address fields in this order
A 754 // available placeholders: {street}, {locality}, {zipcode}, {country}, {region}
755 $rcmail_config['address_template'] = '{street}<br/>{locality} {zipcode}<br/>{country} {region}';
756
f21a04 757 // Matching mode for addressbook search (including autocompletion)
A 758 // 0 - partial (*abc*), default
759 // 1 - strict (abc)
760 // 2 - prefix (abc*)
761 // Note: For LDAP sources fuzzy_search must be enabled to use 'partial' or 'prefix' mode
762 $rcmail_config['addressbook_search_mode'] = 0;
763
95d90f 764 // ----------------------------------
A 765 // USER PREFERENCES
4e17e6 766 // ----------------------------------
T 767
67effe 768 // Use this charset as fallback for message decoding
A 769 $rcmail_config['default_charset'] = 'ISO-8859-1';
e58df3 770
4e17e6 771 // skin name: folder from skins/
9f1652 772 $rcmail_config['skin'] = 'larry';
4e17e6 773
3863a9 774 // Enables using standard browser windows (that can be handled as tabs)
AM 775 // instead of popup windows
776 $rcmail_config['standard_windows'] = false;
777
08ffd9 778 // show up to X items in messages list view
A 779 $rcmail_config['mail_pagesize'] = 50;
780
781 // show up to X items in contacts list view
782 $rcmail_config['addressbook_pagesize'] = 50;
4e17e6 783
438753 784 // sort contacts by this col (preferably either one of name, firstname, surname)
T 785 $rcmail_config['addressbook_sort_col'] = 'surname';
786
f9a967 787 // the way how contact names are displayed in the list
T 788 // 0: display name
789 // 1: (prefix) firstname middlename surname (suffix)
790 // 2: (prefix) surname firstname middlename (suffix)
791 // 3: (prefix) surname, firstname middlename (suffix)
792 $rcmail_config['addressbook_name_listing'] = 0;
793
4e17e6 794 // use this timezone to display date/time
5879c0 795 // valid timezone identifers are listed here: php.net/manual/en/timezones.php
T 796 // 'auto' will use the browser's timezone settings
c8ae24 797 $rcmail_config['timezone'] = 'auto';
4647e1 798
4e17e6 799 // prefer displaying HTML messages
T 800 $rcmail_config['prefer_html'] = true;
801
2a4135 802 // display remote inline images
A 803 // 0 - Never, always ask
804 // 1 - Ask if sender is not in address book
805 // 2 - Always show inline images
806 $rcmail_config['show_images'] = 0;
712b30 807
271efe 808 // open messages in new window
TB 809 $rcmail_config['message_extwin'] = false;
810
811 // open message compose form in new window
812 $rcmail_config['compose_extwin'] = false;
813
b19097 814 // compose html formatted messages by default
8eefbb 815 // 0 - never, 1 - always, 2 - on reply to HTML message, 3 - on forward or reply to HTML message
868deb 816 $rcmail_config['htmleditor'] = 0;
b19097 817
30233b 818 // show pretty dates as standard
2d08c5 819 $rcmail_config['prettydate'] = true;
4e17e6 820
d656f1 821 // save compose message every 300 seconds (5min)
T 822 $rcmail_config['draft_autosave'] = 300;
0566ad 823
b19097 824 // default setting if preview pane is enabled
2d08c5 825 $rcmail_config['preview_pane'] = false;
b19097 826
bc4960 827 // Mark as read when viewed in preview pane (delay in seconds)
T 828 // Set to -1 if messages in preview pane should not be marked as read
829 $rcmail_config['preview_pane_mark_read'] = 0;
830
eaa394 831 // Clear Trash on logout
2d08c5 832 $rcmail_config['logout_purge'] = false;
eaa394 833
A 834 // Compact INBOX on logout
2d08c5 835 $rcmail_config['logout_expunge'] = false;
50c753 836
166b61 837 // Display attached images below the message body 
2d08c5 838 $rcmail_config['inline_images'] = true;
5e0045 839
ffae15 840 // Encoding of long/non-ascii attachment names:
A 841 // 0 - Full RFC 2231 compatible
842 // 1 - RFC 2047 for 'name' and RFC 2231 for 'filename' parameter (Thunderbird's default)
843 // 2 - Full 2047 compatible
21c277 844 $rcmail_config['mime_param_folding'] = 1;
ffae15 845
2d08c5 846 // Set true if deleted messages should not be displayed
2b5852 847 // This will make the application run slower
2d08c5 848 $rcmail_config['skip_deleted'] = false;
2b5852 849
A 850 // Set true to Mark deleted messages as read as well as deleted
851 // False means that a message's read status is not affected by marking it as deleted
2d08c5 852 $rcmail_config['read_when_deleted'] = true;
2b5852 853
ca8a17 854 // Set to true to never delete messages immediately
A 855 // Use 'Purge' to remove messages marked as deleted
2d08c5 856 $rcmail_config['flag_for_deletion'] = false;
2b5852 857
aa8359 858 // Default interval for auto-refresh requests (in seconds)
AM 859 // These are requests for system state updates e.g. checking for new messages, etc.
860 // Setting it to 0 disables the feature.
f22654 861 $rcmail_config['refresh_interval'] = 60;
95d90f 862
2fd975 863 // If true all folders will be checked for recent messages
2d08c5 864 $rcmail_config['check_all_folders'] = false;
2fd975 865
e54bb7 866 // If true, after message delete/move, the next message will be displayed
b1f30d 867 $rcmail_config['display_next'] = true;
e54bb7 868
f52c93 869 // 0 - Do not expand threads 
T 870 // 1 - Expand all threads automatically 
871 // 2 - Expand only threads with unread messages 
872 $rcmail_config['autoexpand_threads'] = 0;
1cead0 873
651c7b 874 // When replying:
AM 875 // -1 - don't cite the original message
876 // 0  - place cursor below the original message
877 // 1  - place cursor above original message (top posting)
878 $rcmail_config['reply_mode'] = 0;
50f56d 879
0207c4 880 // When replying strip original signature from message
2d08c5 881 $rcmail_config['strip_existing_sig'] = true;
0207c4 882
50f56d 883 // Show signature:
0207c4 884 // 0 - Never
T 885 // 1 - Always
50f56d 886 // 2 - New messages only
0207c4 887 // 3 - Forwards and Replies only
T 888 $rcmail_config['show_sig'] = 1;
889
47ad83 890 // Use MIME encoding (quoted-printable) for 8bit characters in message body
2d08c5 891 $rcmail_config['force_7bit'] = false;
47ad83 892
b975da 893 // Defaults of the search field configuration.
T 894 // The array can contain a per-folder list of header fields which should be considered when searching
895 // The entry with key '*' stands for all folders which do not have a specific list set.
bf9dde 896 // Please note that folder names should to be in sync with $rcmail_config['default_folders']
b975da 897 $rcmail_config['search_mods'] = null;  // Example: array('*' => array('subject'=>1, 'from'=>1), 'Sent' => array('subject'=>1, 'to'=>1));
T 898
3cacf9 899 // Defaults of the addressbook search field configuration.
A 900 $rcmail_config['addressbook_search_mods'] = null;  // Example: array('name'=>1, 'firstname'=>1, 'surname'=>1, 'email'=>1, '*'=>1);
901
b7f952 902 // 'Delete always'
A 903 // This setting reflects if mail should be always deleted
904 // when moving to Trash fails. This is necessary in some setups
905 // when user is over quota and Trash is included in the quota.
906 $rcmail_config['delete_always'] = false;
907
1b30a7 908 // Directly delete messages in Junk instead of moving to Trash
A 909 $rcmail_config['delete_junk'] = false;
910
f22ea7 911 // Behavior if a received message requests a message delivery notification (read receipt)
A 912 // 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask)
913 // 3 = send automatically if sender is in addressbook, otherwise ask the user
914 // 4 = send automatically if sender is in addressbook, otherwise ignore
915 $rcmail_config['mdn_requests'] = 0;
b25dfd 916
f22ea7 917 // Return receipt checkbox default state
A 918 $rcmail_config['mdn_default'] = 0;
919
920 // Delivery Status Notification checkbox default state
921 $rcmail_config['dsn_default'] = 0;
922
eeb85f 923 // Place replies in the folder of the message being replied to
A 924 $rcmail_config['reply_same_folder'] = false;
925
a509bb 926 // Sets default mode of Forward feature to "forward as attachment"
A 927 $rcmail_config['forward_attachment'] = false;
928
d73448 929 // Defines address book (internal index) to which new contacts will be added
A 930 // By default it is the first writeable addressbook.
931 // Note: Use '0' for built-in address book.
932 $rcmail_config['default_addressbook'] = null;
933
1d5779 934 // Enables spell checking before sending a message.
A 935 $rcmail_config['spellcheck_before_send'] = false;
936
710b1b 937 // Skip alternative email addresses in autocompletion (show one address per contact)
A 938 $rcmail_config['autocomplete_single'] = false;
939
7e263e 940 // Default font for composed HTML message.
A 941 // Supported values: Andale Mono, Arial, Arial Black, Book Antiqua, Courier New,
942 // Georgia, Helvetica, Impact, Tahoma, Terminal, Times New Roman, Trebuchet MS, Verdana
07795b 943 $rcmail_config['default_font'] = 'Verdana';
7e263e 944
969cb0 945 // Enables display of email address with name instead of a name (and address in title)
AM 946 $rcmail_config['message_show_email'] = false;