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