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