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