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