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