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