alecpl
2010-03-02 47ad83f337c9eeb4bc53afb85a71cf90a8a34106
commit | author | age
4e17e6 1 <?php
T 2
3 /*
4  +-----------------------------------------------------------------------+
5  | Main configuration file                                               |
6  |                                                                       |
7  | This file is part of the RoundCube Webmail client                     |
cbbef3 8  | Copyright (C) 2005-2009, RoundCube Dev. - Switzerland                 |
52c1f2 9  | Licensed under the GNU GPL                                            |
4e17e6 10  |                                                                       |
T 11  +-----------------------------------------------------------------------+
12
13 */
14
15 $rcmail_config = array();
16
968bdc 17 // system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace
13c1af 18 $rcmail_config['debug_level'] = 1;
4e17e6 19
b77d0d 20 // log driver:  'syslog' or 'file'.
A 21 $rcmail_config['log_driver'] = 'file';
22
0ad27c 23 // date format for log entries
A 24 // (read http://php.net/manual/en/function.date.php for all format characters)  
25 $rcmail_config['log_date_format'] = 'd-M-Y H:i:s O';
26
b77d0d 27 // Syslog ident string to use, if using the 'syslog' log driver.
A 28 $rcmail_config['syslog_id'] = 'roundcube';
29
30 // Syslog facility to use, if using the 'syslog' log driver.
31 // For possible values see installer or http://php.net/manual/en/function.openlog.php
32 $rcmail_config['syslog_facility'] = LOG_USER;
33
a91c9b 34 // use this folder to store log files (must be writeable for apache user)
b77d0d 35 // This is used by the 'file' log driver.
A 36 $rcmail_config['log_dir'] = 'logs/';
37
38 // use this folder to store temp files (must be writeable for apache user)
39 $rcmail_config['temp_dir'] = 'temp/';
40
7dbe2f 41 // List of active plugins (in plugins/ directory)
cc97ea 42 $rcmail_config['plugins'] = array();
T 43
6dc026 44 // enable caching of messages and mailbox data in the local database.
T 45 // this is recommended if the IMAP server does not run on the same machine
9e2a7a 46 $rcmail_config['enable_caching'] = FALSE;
6dc026 47
cc9570 48 // lifetime of message cache
T 49 // possible units: s, m, h, d, w
50 $rcmail_config['message_cache_lifetime'] = '10d';
51
f5d61d 52 // enforce connections over https
T 53 // with this option enabled, all non-secure connections will be redirected.
54 // set the port for the ssl connection as value of this option if it differs from the default 443
55 $rcmail_config['force_https'] = FALSE;
56
7902df 57 // automatically create a new RoundCube user when log-in the first time.
7cc38e 58 // a new user will be created once the IMAP login succeeds.
4e17e6 59 // set to false if only registered users can use this service
T 60 $rcmail_config['auto_create_user'] = TRUE;
61
62 // the mail host chosen to perform the log-in
63 // leave blank to show a textbox at login, give a list of hosts
42b113 64 // to display a pulldown menu or set one host as string.
f86e8f 65 // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
4e17e6 66 $rcmail_config['default_host'] = '';
T 67
42b113 68 // TCP port used for IMAP connections
T 69 $rcmail_config['default_port'] = 143;
70
aec031 71 // IMAP auth type. Can be "auth" (CRAM-MD5), "plain" (PLAIN) or "check" to auto detect.
T 72 // Optional, defaults to "check"
b026c3 73 $rcmail_config['imap_auth_type'] = null;
T 74
030c84 75 // If you know your imap's root directory and its folder delimiter,
230f94 76 // you can specify them here. Otherwise they will be determined automatically.
030c84 77 $rcmail_config['imap_root'] = null;
A 78 $rcmail_config['imap_delimiter'] = null;
79
0566ad 80 // Automatically add this domain to user names for login
T 81 // Only for IMAP servers that require full e-mail addresses for login
82 // Specify an array with 'host' => 'domain' values to support multiple hosts
83 $rcmail_config['username_domain'] = '';
84
977a29 85 // This domain will be used to form e-mail addresses of new users
T 86 // Specify an array with 'host' => 'domain' values to support multiple hosts
13c1af 87 $rcmail_config['mail_domain'] = '';
977a29 88
T 89 // Path to a virtuser table file to resolve user names and e-mail addresses
90 $rcmail_config['virtuser_file'] = '';
91
f88d41 92 // Query to resolve user names and e-mail addresses from the database
T 93 // %u will be replaced with the current username for login.
1301e9 94 // The query should select the user's e-mail address as first column
A 95 // and optional identity name as second column
f88d41 96 $rcmail_config['virtuser_query'] = '';
T 97
c3b676 98 // SMTP server host (for sending mails).
A 99 // To use SSL connection, set ssl://smtp.host.com
100 // WARNING: Don't use 'tls://' prefix, TLS is used by default if possible
101 // If left blank, the PHP mail() function is used
72cd3c 102 // Use %h variable as replacement for user's IMAP hostname
4e17e6 103 $rcmail_config['smtp_server'] = '';
T 104
fd8c50 105 // SMTP port (default is 25; 465 for SSL)
968bdc 106 $rcmail_config['smtp_port'] = 25;
T 107
d206c1 108 // SMTP username (if required) if you use %u as the username RoundCube
S 109 // will use the current username for login
4e17e6 110 $rcmail_config['smtp_user'] = '';
T 111
d206c1 112 // SMTP password (if required) if you use %p as the password RoundCube
S 113 // will use the current user's password for login
4e17e6 114 $rcmail_config['smtp_pass'] = '';
T 115
d206c1 116 // SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
S 117 // best server supported one)
118 $rcmail_config['smtp_auth_type'] = '';
119
aca3d2 120 // SMTP HELO host 
S 121 // Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages 
122 // Leave this blank and you will get the server variable 'server_name' or 
123 // localhost if that isn't defined. 
124 $rcmail_config['smtp_helo_host'] = '';
125
64608b 126 // Password charset.
A 127 // Use it if your authentication backend doesn't support UTF-8.
128 // Defaults to ISO-8859-1 for backward compatibility
129 $rcmail_config['password_charset'] = 'ISO-8859-1';
130
4e17e6 131 // Log sent messages
T 132 $rcmail_config['smtp_log'] = TRUE;
133
d559cb 134 // Log SQL queries to <log_dir>/sql or to syslog
A 135 $rcmail_config['sql_debug'] = false;
136
137 // Log IMAP conversation to <log_dir>/imap or to syslog
138 $rcmail_config['imap_debug'] = false;
139
010274 140 // Log LDAP conversation to <log_dir>/ldap or to syslog
A 141 $rcmail_config['ldap_debug'] = false;
142
19862b 143 // Log SMTP conversation to <log_dir>/smtp or to syslog
A 144 $rcmail_config['smtp_debug'] = false;
145
95d90f 146 // How many seconds must pass between emails sent by a user
acb08f 147 $rcmail_config['sendmail_delay'] = 0;
A 148
d59aaa 149 // These cols are shown in the message list. Available cols are:
58687d 150 // subject, from, to, cc, replyto, date, size, flag, attachment
d59aaa 151 $rcmail_config['list_cols'] = array('subject', 'from', 'date', 'size', 'flag', 'attachment');
4e17e6 152
95d90f 153 // Includes should be interpreted as PHP files
e9ac14 154 $rcmail_config['skin_include_php'] = FALSE;
fd8c50 155
95d90f 156 // Session lifetime in minutes
A 157 // must be greater than 'keep_alive'/60
7902df 158 $rcmail_config['session_lifetime'] = 10;
T 159
4e17e6 160 // check client IP in session athorization
aad6e2 161 $rcmail_config['ip_check'] = false;
T 162
163 // Use an additional frequently changing cookie to athenticate user sessions.
164 // There have been problems reported with this feature.
165 $rcmail_config['double_auth'] = false;
4e17e6 166
bac7d1 167 // this key is used to encrypt the users imap password which is stored
T 168 // in the session record (and the client cookie if remember password is enabled).
169 // please provide a string of exactly 24 chars.
170 $rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str';
171
c8ae24 172 // the default locale setting (leave empty for auto-detection)
T 173 // RFC1766 formatted language name like en_US, de_DE, de_CH, fr_FR, pt_BR
174 $rcmail_config['language'] = null;
4e17e6 175
b6b593 176 // use this format for short date display (date or strftime format)
4e17e6 177 $rcmail_config['date_short'] = 'D H:i';
T 178
b6b593 179 // use this format for detailed date/time formatting (date or strftime format)
4e17e6 180 $rcmail_config['date_long'] = 'd.m.Y H:i';
T 181
b6b593 182 // use this format for today's date display (date or strftime format)
8c8b2a 183 $rcmail_config['date_today'] = 'H:i';
S 184
4e17e6 185 // add this user-agent to message headers when sending
4d9707 186 $rcmail_config['useragent'] = 'RoundCube Webmail/'.RCMAIL_VERSION;
4e17e6 187
15a9d1 188 // use this name to compose page titles
T 189 $rcmail_config['product_name'] = 'RoundCube Webmail';
4e17e6 190
1966c5 191 // store draft message is this mailbox
S 192 // leave blank if draft messages should not be stored
193 $rcmail_config['drafts_mbox'] = 'Drafts';
194
b4b081 195 // store spam messages in this mailbox
S 196 $rcmail_config['junk_mbox'] = 'Junk';
197
4e17e6 198 // store sent message is this mailbox
T 199 // leave blank if sent messages should not be stored
200 $rcmail_config['sent_mbox'] = 'Sent';
201
202 // move messages to this folder when deleting them
203 // leave blank if they should be deleted directly
204 $rcmail_config['trash_mbox'] = 'Trash';
205
fa4cd2 206 // display these folders separately in the mailbox list.
83ce4b 207 // these folders will also be displayed with localized names
4e17e6 208 $rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash');
T 209
b2ff3d 210 // automatically create the above listed default folders on login
T 211 $rcmail_config['create_default_folders'] = FALSE;
212
c8c1e0 213 // protect the default folders from renames, deletes, and subscription changes
S 214 $rcmail_config['protect_default_folders'] = TRUE;
215
876b15 216 // if in your system 0 quota means no limit set this option to TRUE 
A 217 $rcmail_config['quota_zero_as_unlimited'] = FALSE;
218
0ea884 219 // Behavior if a received message requests a message delivery notification (read receipt)
T 220 // 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask)
221 $rcmail_config['mdn_requests'] = 0;
222
967b34 223 // Use this charset as fallback for message decoding
17b5fb 224 $rcmail_config['default_charset'] = 'ISO-8859-1';
T 225
996066 226 // Make use of the built-in spell checker. It is based on GoogieSpell.
e9ac14 227 // Since Google only accepts connections over https your PHP installatation
T 228 // requires to be compiled with Open SSL support
ed5d29 229 $rcmail_config['enable_spellcheck'] = TRUE;
T 230
5d2b7f 231 // Set the spell checking engine. 'googie' is the default. 'pspell' is also available,
T 232 // but requires the Pspell extensions. When using Nox Spell Server, also set 'googie' here.
233 $rcmail_config['spellcheck_engine'] = 'googie';
234
996066 235 // For a locally installed Nox Spell Server, please specify the URI to call it.
T 236 // Get Nox Spell Server from http://orangoo.com/labs/?page_id=72
237 // Leave empty to use the Google spell checking service, what means
238 // that the message content will be sent to Google in order to check spelling
239 $rcmail_config['spellcheck_uri'] = '';
240
241 // These languages can be selected for spell checking.
242 // Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch');
01a8c5 243 // Leave empty for default set of available language.
996066 244 $rcmail_config['spellcheck_languages'] = NULL;
T 245
4b0f65 246 // path to a text file which will be added to each sent message
T 247 // paths are relative to the RoundCube root folder
248 $rcmail_config['generic_message_footer'] = '';
967b34 249
T 250 // add a received header to outgoing mails containing the creators IP and hostname
251 $rcmail_config['http_received_header'] = false;
4b0f65 252
2471d3 253 // Whether or not to encrypt the IP address and the host name
A 254 // these could, in some circles, be considered as sensitive information;
255 // however, for the administrator, these could be invaluable help
256 // when tracking down issues.
257 $rcmail_config['http_received_header_encrypt'] = false;
258
4b0f65 259 // this string is used as a delimiter for message headers when sending
4647e1 260 // leave empty for auto-detection
T 261 $rcmail_config['mail_header_delimiter'] = NULL;
b076a4 262
aec82b 263 // session domain: .example.org
T 264 $rcmail_config['session_domain'] = '';
265
6153e2 266 // This indicates which type of address book to use. Possible choises:
A 267 // 'sql' (default) and 'ldap'.
268 // If set to 'ldap' then it will look at using the first writable LDAP
4f9c83 269 // address book as the primary address book and it will not display the
S 270 // SQL address book in the 'Address Book' view.
6153e2 271 $rcmail_config['address_book_type'] = 'sql';
4f9c83 272
S 273 // In order to enable public ldap search, configure an array like the Verisign
274 // example further below. if you would like to test, simply uncomment the example.
5f25a1 275 $rcmail_config['ldap_public'] = array();
T 276
4f9c83 277 //
S 278 // If you are going to use LDAP for individual address books, you will need to 
279 // set 'user_specific' to true and use the variables to generate the appropriate DNs to access it.
280 //
281 // The recommended directory structure for LDAP is to store all the address book entries
282 // under the users main entry, e.g.:
283 //
284 //  o=root
285 //   ou=people
286 //    uid=user@domain
3b9a53 287 //  mail=contact@contactdomain
T 288 //
4f9c83 289 // So the base_dn would be uid=%fu,ou=people,o=root
S 290 // The bind_dn would be the same as based_dn or some super user login.
3b9a53 291 /* 
f11541 292  * example config for Verisign directory
eea43f 293  *
3b9a53 294 $rcmail_config['ldap_public']['Verisign'] = array(
T 295   'name'          => 'Verisign.com',
296   'hosts'         => array('directory.verisign.com'),
297   'port'          => 389,
298   'use_tls'        => false,
299   'user_specific' => false,   // If true the base_dn, bind_dn and bind_pass default to the user's IMAP login.
300   // %fu - The full username provided, assumes the username is an email
301   //       address, uses the username_domain value if not an email address.
302   // %u  - The username prior to the '@'.
303   // %d  - The domain name after the '@'.
304   'base_dn'       => '',
305   'bind_dn'       => '',
306   'bind_pass'     => '',
307   'writable'      => false,   // Indicates if we can write to the LDAP directory or not.
308   // If writable is true then these fields need to be populated:
309   // LDAP_Object_Classes, required_fields, LDAP_rdn
310   'LDAP_Object_Classes' => array("top", "inetOrgPerson"), // To create a new contact these are the object classes to specify (or any other classes you wish to use).
311   'required_fields'     => array("cn", "sn", "mail"),     // The required fields needed to build a new contact as required by the object classes (can include additional fields not required by the object classes).
312   'LDAP_rdn'      => 'mail', // The RDN field that is used for new entries, this field needs to be one of the search_fields, the base of base_dn is appended to the RDN to insert into the LDAP directory.
313   'ldap_version'  => 3,       // using LDAPv3
314   'search_fields' => array('mail', 'cn'),  // fields to search in
315   'name_field'    => 'cn',    // this field represents the contact's name
316   'email_field'   => 'mail',  // this field represents the contact's e-mail
317   'surname_field' => 'sn',    // this field represents the contact's last name
318   'firstname_field' => 'gn',  // this field represents the contact's first name
319   'sort'          => 'cn',    // The field to sort the listing by.
320   'scope'         => 'sub',   // search mode: sub|base|list
321   'filter'        => '',      // used for basic listing (if not empty) and will be &'d with search queries. example: status=act
322   'fuzzy_search'  => true);   // server allows wildcard search
323 */
d1d2c4 324
2c8e84 325 // An ordered array of the ids of the addressbooks that should be searched
T 326 // when populating address autocomplete fields server-side. ex: array('sql','Verisign');
327 $rcmail_config['autocomplete_addressbooks'] = array('sql');
328
b19097 329 // don't allow these settings to be overriden by the user
T 330 $rcmail_config['dont_override'] = array();
331
ec0171 332 // Set identities access level:
A 333 // 0 - many identities with possibility to edit all params
334 // 1 - many identities with possibility to edit all params but not email address
335 // 2 - one identity with possibility to edit all params
336 // 3 - one identity with possibility to edit all params but not email address
337 $rcmail_config['identities_level'] = 0;
f645ce 338
9606ff 339 // try to load host-specific configuration
2ca388 340 // see http://trac.roundcube.net/wiki/Howto_Config for more details
967b34 341 $rcmail_config['include_host_config'] = false;
T 342
fe6b7a 343 // don't let users set pagesize to more than this value if set
A 344 $rcmail_config['max_pagesize'] = 200;
345
346 // mime magic database
347 $rcmail_config['mime_magic'] = '/usr/share/misc/magic';
348
349 // default sort col
350 $rcmail_config['message_sort_col'] = 'date';
351
352 // default sort order
353 $rcmail_config['message_sort_order'] = 'DESC';
354
967b34 355 // THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA.
T 356 // ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING!
357 $rcmail_config['enable_installer'] = false;
4e17e6 358
166b61 359 // Log successful logins
A 360 $rcmail_config['log_logins'] = false;
361
362 /**
363  * 'Delete always'
364  * This setting reflects if mail should be always marked as deleted,
365  * even if moving to "Trash" fails. This is necessary in some setups
366  * because a) people may not have a Trash folder or b) they are over
367  * quota (and Trash is included in the quota).
368  *
369  * This is a failover setting for iil_C_Move when a message is moved
d1a8d0 370  * to the Trash.
166b61 371  */
A 372 $rcmail_config['delete_always'] = false;
373
95d90f 374 // Minimal value of user's 'keep_alive' setting (in seconds)
A 375 // Must be less than 'session_lifetime'
376 $rcmail_config['min_keep_alive'] = 60;
377
e4acbb 378 // Enable DNS checking for e-mail address validation
A 379 $rcmail_config['email_dns_check'] = false;
380
4e17e6 381 /***** these settings can be overwritten by user's preferences *****/
T 382
67effe 383 // skin name: folder from skins/
A 384 $rcmail_config['skin'] = 'default';
e58df3 385
4e17e6 386 // show up to X items in list view
T 387 $rcmail_config['pagesize'] = 40;
388
389 // use this timezone to display date/time
c8ae24 390 $rcmail_config['timezone'] = 'auto';
4e17e6 391
5349b7 392 // is daylight saving On?
d7d663 393 $rcmail_config['dst_active'] = (bool)date('I');
4647e1 394
4e17e6 395 // prefer displaying HTML messages
T 396 $rcmail_config['prefer_html'] = TRUE;
397
2a4135 398 // display remote inline images
A 399 // 0 - Never, always ask
400 // 1 - Ask if sender is not in address book
401 // 2 - Always show inline images
402 $rcmail_config['show_images'] = 0;
712b30 403
b19097 404 // compose html formatted messages by default
45a470 405 $rcmail_config['htmleditor'] = FALSE;
b19097 406
30233b 407 // show pretty dates as standard
T 408 $rcmail_config['prettydate'] = TRUE;
4e17e6 409
d656f1 410 // save compose message every 300 seconds (5min)
T 411 $rcmail_config['draft_autosave'] = 300;
0566ad 412
b19097 413 // default setting if preview pane is enabled
T 414 $rcmail_config['preview_pane'] = FALSE;
415
06343d 416 // focus new window if new message arrives
A 417 $rcmail_config['focus_on_new_message'] = true;
418
eaa394 419 // Clear Trash on logout
A 420 $rcmail_config['logout_purge'] = FALSE;
421
422 // Compact INBOX on logout
423 $rcmail_config['logout_expunge'] = FALSE;
50c753 424
166b61 425 // Display attached images below the message body 
A 426 $rcmail_config['inline_images'] = TRUE;
5e0045 427
ffae15 428 // Encoding of long/non-ascii attachment names:
A 429 // 0 - Full RFC 2231 compatible
430 // 1 - RFC 2047 for 'name' and RFC 2231 for 'filename' parameter (Thunderbird's default)
431 // 2 - Full 2047 compatible
21c277 432 $rcmail_config['mime_param_folding'] = 1;
ffae15 433
2b5852 434 // Set TRUE if deleted messages should not be displayed
A 435 // This will make the application run slower
436 $rcmail_config['skip_deleted'] = FALSE;
437
438 // Set true to Mark deleted messages as read as well as deleted
439 // False means that a message's read status is not affected by marking it as deleted
440 $rcmail_config['read_when_deleted'] = TRUE;
441
119cd1 442 // Set to TRUE to newer delete messages immediately
A 443 // Use 'Purge' to remove messages marked as deleted 
2b5852 444 $rcmail_config['flag_for_deletion'] = FALSE;
A 445
95d90f 446 // Default interval for keep-alive/check-recent requests (in seconds)
A 447 // Must be greater than or equal to 'min_keep_alive' and less than 'session_lifetime'
448 $rcmail_config['keep_alive'] = 60;
449
2fd975 450 // If true all folders will be checked for recent messages
T 451 $rcmail_config['check_all_folders'] = FALSE;
452
e54bb7 453 // If true, after message delete/move, the next message will be displayed
A 454 $rcmail_config['display_next'] = FALSE;
455
1cead0 456 // If true, messages list will be sorted by message index instead of message date
A 457 $rcmail_config['index_sort'] = TRUE;
458
50f56d 459 // When replying place cursor above original message (top posting)
A 460 $rcmail_config['top_posting'] = FALSE;
461
0207c4 462 // When replying strip original signature from message
T 463 $rcmail_config['strip_existing_sig'] = TRUE;
464
50f56d 465 // Show signature:
0207c4 466 // 0 - Never
T 467 // 1 - Always
50f56d 468 // 2 - New messages only
0207c4 469 // 3 - Forwards and Replies only
T 470 $rcmail_config['show_sig'] = 1;
471
472 // When replying or forwarding place sender's signature above existing message
473 $rcmail_config['sig_above'] = FALSE;
50f56d 474
47ad83 475 // Use MIME encoding (quoted-printable) for 8bit characters in message body
A 476 $rcmail_config['force_7bit'] = FALSE;
477
4e17e6 478 // end of config file
1966c5 479 ?>