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