| commit | author | age | ||
| 4e17e6 | 1 | <?php |
| T | 2 | |
| 3 | /* | |
| 4 | +-----------------------------------------------------------------------+ | |
| 5 | | Main configuration file | | |
| 6 | | | | |
| e019f2 | 7 | | This file is part of the Roundcube Webmail client | |
| f5e7b3 | 8 | | Copyright (C) 2005-2010, The Roundcube Dev Team | |
| 52c1f2 | 9 | | Licensed under the GNU GPL | |
| 4e17e6 | 10 | | | |
| T | 11 | +-----------------------------------------------------------------------+ |
| 12 | ||
| 13 | */ | |
| 14 | ||
| 15 | $rcmail_config = array(); | |
| 16 | ||
| 2d08c5 | 17 | // ---------------------------------- |
| A | 18 | // LOGGING/DEBUGGING |
| 19 | // ---------------------------------- | |
| 20 | ||
| 968bdc | 21 | // system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace |
| 13c1af | 22 | $rcmail_config['debug_level'] = 1; |
| 4e17e6 | 23 | |
| b77d0d | 24 | // log driver: 'syslog' or 'file'. |
| A | 25 | $rcmail_config['log_driver'] = 'file'; |
| 26 | ||
| 0ad27c | 27 | // date format for log entries |
| A | 28 | // (read http://php.net/manual/en/function.date.php for all format characters) |
| 29 | $rcmail_config['log_date_format'] = 'd-M-Y H:i:s O'; | |
| 30 | ||
| b77d0d | 31 | // Syslog ident string to use, if using the 'syslog' log driver. |
| A | 32 | $rcmail_config['syslog_id'] = 'roundcube'; |
| 33 | ||
| 34 | // Syslog facility to use, if using the 'syslog' log driver. | |
| 35 | // For possible values see installer or http://php.net/manual/en/function.openlog.php | |
| 36 | $rcmail_config['syslog_facility'] = LOG_USER; | |
| 37 | ||
| 3e3429 | 38 | // Log sent messages to <log_dir>/sendmail or to syslog |
| 2d08c5 | 39 | $rcmail_config['smtp_log'] = true; |
| b77d0d | 40 | |
| 3e3429 | 41 | // Log successful logins to <log_dir>/userlogins or to syslog |
| 2d08c5 | 42 | $rcmail_config['log_logins'] = false; |
| b77d0d | 43 | |
| fcc7f8 | 44 | // Log session authentication errors to <log_dir>/session or to syslog |
| T | 45 | $rcmail_config['log_session'] = false; |
| 46 | ||
| 2d08c5 | 47 | // Log SQL queries to <log_dir>/sql or to syslog |
| A | 48 | $rcmail_config['sql_debug'] = false; |
| cc97ea | 49 | |
| 2d08c5 | 50 | // Log IMAP conversation to <log_dir>/imap or to syslog |
| A | 51 | $rcmail_config['imap_debug'] = false; |
| 6dc026 | 52 | |
| 2d08c5 | 53 | // Log LDAP conversation to <log_dir>/ldap or to syslog |
| A | 54 | $rcmail_config['ldap_debug'] = false; |
| cc9570 | 55 | |
| 2d08c5 | 56 | // Log SMTP conversation to <log_dir>/smtp or to syslog |
| A | 57 | $rcmail_config['smtp_debug'] = false; |
| f5d61d | 58 | |
| 2d08c5 | 59 | // ---------------------------------- |
| A | 60 | // IMAP |
| 61 | // ---------------------------------- | |
| 4e17e6 | 62 | |
| T | 63 | // the mail host chosen to perform the log-in |
| 64 | // leave blank to show a textbox at login, give a list of hosts | |
| 42b113 | 65 | // to display a pulldown menu or set one host as string. |
| f86e8f | 66 | // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls:// |
| bb8721 | 67 | // Supported replacement variables: |
| A | 68 | // %n - http hostname ($_SERVER['SERVER_NAME']) |
| 69 | // %d - domain (http hostname without the first part) | |
| b04c51 | 70 | // %s - domain name after the '@' from e-mail address provided at login screen |
| bb8721 | 71 | // For example %n = mail.domain.tld, %d = domain.tld |
| 4e17e6 | 72 | $rcmail_config['default_host'] = ''; |
| T | 73 | |
| 42b113 | 74 | // TCP port used for IMAP connections |
| T | 75 | $rcmail_config['default_port'] = 143; |
| 76 | ||
| 4dd417 | 77 | // IMAP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use |
| A | 78 | // best server supported one) |
| b026c3 | 79 | $rcmail_config['imap_auth_type'] = null; |
| T | 80 | |
| 00290a | 81 | // If you know your imap's folder delimiter, you can specify it here. |
| A | 82 | // Otherwise it will be determined automatically |
| 030c84 | 83 | $rcmail_config['imap_delimiter'] = null; |
| A | 84 | |
| 00290a | 85 | // If IMAP server doesn't support NAMESPACE extension, but you're |
| A | 86 | // using shared folders or personal root folder is non-empty, you'll need to |
| 87 | // set these options. All can be strings or arrays of strings. | |
| e3af1f | 88 | // Folders need to be ended with directory separator, e.g. "INBOX." |
| A | 89 | // (special directory "~" is an exception to this rule) |
| 02491a | 90 | // These can be used also to overwrite server's namespaces |
| 00290a | 91 | $rcmail_config['imap_ns_personal'] = null; |
| A | 92 | $rcmail_config['imap_ns_other'] = null; |
| 93 | $rcmail_config['imap_ns_shared'] = null; | |
| 94 | ||
| d8c440 | 95 | // By default IMAP capabilities are readed after connection to IMAP server |
| A | 96 | // In some cases, e.g. when using IMAP proxy, there's a need to refresh the list |
| 97 | // after login. Set to True if you've got this case. | |
| 98 | $rcmail_config['imap_force_caps'] = false; | |
| 99 | ||
| f75f65 | 100 | // By default list of subscribed folders is determined using LIST-EXTENDED |
| A | 101 | // extension if available. Some servers (dovecot 1.x) returns wrong results |
| 102 | // for shared namespaces in this case. http://trac.roundcube.net/ticket/1486225 | |
| 103 | // Enable this option to force LSUB command usage instead. | |
| 104 | $rcmail_config['imap_force_lsub'] = false; | |
| 105 | ||
| f07d23 | 106 | // IMAP connection timeout, in seconds. Default: 0 (no limit) |
| A | 107 | $rcmail_config['imap_timeout'] = 0; |
| 108 | ||
| a1fe6b | 109 | // Optional IMAP authentication identifier to be used as authorization proxy |
| A | 110 | $rcmail_config['imap_auth_cid'] = null; |
| 111 | ||
| 112 | // Optional IMAP authentication password to be used for imap_auth_cid | |
| 113 | $rcmail_config['imap_auth_pw'] = null; | |
| 114 | ||
| 8edb3d | 115 | // Type of IMAP indexes cache. Supported values: 'db', 'apc' and 'memcache'. |
| 5cf5ee | 116 | $rcmail_config['imap_cache'] = null; |
| A | 117 | |
| 118 | // Enables messages cache. Only 'db' cache is supported. | |
| 119 | $rcmail_config['messages_cache'] = false; | |
| 120 | ||
| 121 | ||
| 2d08c5 | 122 | // ---------------------------------- |
| A | 123 | // SMTP |
| 124 | // ---------------------------------- | |
| f88d41 | 125 | |
| c3b676 | 126 | // SMTP server host (for sending mails). |
| 2d08c5 | 127 | // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls:// |
| c3b676 | 128 | // If left blank, the PHP mail() function is used |
| bb8721 | 129 | // Supported replacement variables: |
| A | 130 | // %h - user's IMAP hostname |
| 131 | // %n - http hostname ($_SERVER['SERVER_NAME']) | |
| 132 | // %d - domain (http hostname without the first part) | |
| 11be93 | 133 | // %z - IMAP domain (IMAP hostname without the first part) |
| bb8721 | 134 | // For example %n = mail.domain.tld, %d = domain.tld |
| 4e17e6 | 135 | $rcmail_config['smtp_server'] = ''; |
| T | 136 | |
| fd8c50 | 137 | // SMTP port (default is 25; 465 for SSL) |
| 968bdc | 138 | $rcmail_config['smtp_port'] = 25; |
| T | 139 | |
| e019f2 | 140 | // SMTP username (if required) if you use %u as the username Roundcube |
| d206c1 | 141 | // will use the current username for login |
| 4e17e6 | 142 | $rcmail_config['smtp_user'] = ''; |
| T | 143 | |
| e019f2 | 144 | // SMTP password (if required) if you use %p as the password Roundcube |
| d206c1 | 145 | // will use the current user's password for login |
| 4e17e6 | 146 | $rcmail_config['smtp_pass'] = ''; |
| T | 147 | |
| d206c1 | 148 | // SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use |
| S | 149 | // best server supported one) |
| 150 | $rcmail_config['smtp_auth_type'] = ''; | |
| 151 | ||
| 63d4d6 | 152 | // Optional SMTP authentication identifier to be used as authorization proxy |
| A | 153 | $rcmail_config['smtp_auth_cid'] = null; |
| 154 | ||
| a1fe6b | 155 | // Optional SMTP authentication password to be used for smtp_auth_cid |
| 63d4d6 | 156 | $rcmail_config['smtp_auth_pw'] = null; |
| a39212 | 157 | |
| aca3d2 | 158 | // SMTP HELO host |
| S | 159 | // Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages |
| 160 | // Leave this blank and you will get the server variable 'server_name' or | |
| 161 | // localhost if that isn't defined. | |
| 162 | $rcmail_config['smtp_helo_host'] = ''; | |
| 163 | ||
| f07d23 | 164 | // SMTP connection timeout, in seconds. Default: 0 (no limit) |
| A | 165 | $rcmail_config['smtp_timeout'] = 0; |
| 166 | ||
| 2d08c5 | 167 | // ---------------------------------- |
| A | 168 | // SYSTEM |
| 169 | // ---------------------------------- | |
| 64608b | 170 | |
| 2d08c5 | 171 | // THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA. |
| A | 172 | // ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING! |
| 173 | $rcmail_config['enable_installer'] = false; | |
| 4e17e6 | 174 | |
| 2d08c5 | 175 | // use this folder to store log files (must be writeable for apache user) |
| A | 176 | // This is used by the 'file' log driver. |
| 177 | $rcmail_config['log_dir'] = 'logs/'; | |
| d559cb | 178 | |
| 2d08c5 | 179 | // use this folder to store temp files (must be writeable for apache user) |
| A | 180 | $rcmail_config['temp_dir'] = 'temp/'; |
| 010274 | 181 | |
| 2d08c5 | 182 | // lifetime of message cache |
| A | 183 | // possible units: s, m, h, d, w |
| 184 | $rcmail_config['message_cache_lifetime'] = '10d'; | |
| 19862b | 185 | |
| 2d08c5 | 186 | // enforce connections over https |
| A | 187 | // with this option enabled, all non-secure connections will be redirected. |
| 188 | // set the port for the ssl connection as value of this option if it differs from the default 443 | |
| 189 | $rcmail_config['force_https'] = false; | |
| acb08f | 190 | |
| 00e18b | 191 | // tell PHP that it should work as under secure connection |
| A | 192 | // even if it doesn't recognize it as secure ($_SERVER['HTTPS'] is not set) |
| 193 | // e.g. when you're running Roundcube behind a https proxy | |
| 194 | $rcmail_config['use_https'] = false; | |
| 195 | ||
| 1cca4f | 196 | // Allow browser-autocompletion on login form. |
| A | 197 | // 0 - disabled, 1 - username and host only, 2 - username, host, password |
| 198 | $rcmail_config['login_autocomplete'] = 0; | |
| fbe24e | 199 | |
| e17553 | 200 | // If users authentication is not case sensitive this must be enabled. |
| A | 201 | // You can also use it to force conversion of logins to lower case. |
| caedd5 | 202 | // After enabling it all user records need to be updated, e.g. with query: |
| A | 203 | // UPDATE users SET username = LOWER(username); |
| e17553 | 204 | $rcmail_config['login_lc'] = false; |
| A | 205 | |
| e019f2 | 206 | // automatically create a new Roundcube user when log-in the first time. |
| 2d08c5 | 207 | // a new user will be created once the IMAP login succeeds. |
| A | 208 | // set to false if only registered users can use this service |
| 209 | $rcmail_config['auto_create_user'] = true; | |
| 4e17e6 | 210 | |
| ae39c4 | 211 | // replace Roundcube logo with this image |
| T | 212 | // specify an URL relative to the document root of this Roundcube installation |
| 213 | $rcmail_config['skin_logo'] = null; | |
| 214 | ||
| 95d90f | 215 | // Includes should be interpreted as PHP files |
| 2d08c5 | 216 | $rcmail_config['skin_include_php'] = false; |
| fd8c50 | 217 | |
| 95d90f | 218 | // Session lifetime in minutes |
| A | 219 | // must be greater than 'keep_alive'/60 |
| 7902df | 220 | $rcmail_config['session_lifetime'] = 10; |
| T | 221 | |
| cf2da2 | 222 | // session domain: .example.org |
| T | 223 | $rcmail_config['session_domain'] = ''; |
| 224 | ||
| 63e992 | 225 | // Backend to use for session storage. Can either be 'db' (default) or 'memcache' |
| T | 226 | // If set to memcache, a list of servers need to be specified in 'memcache_hosts' |
| 227 | // Make sure the Memcache extension (http://pecl.php.net/package/memcache) version >= 2.0.0 is installed | |
| 228 | $rcmail_config['session_storage'] = 'db'; | |
| 229 | ||
| 230 | // Use these hosts for accessing memcached | |
| 231 | // Define any number of hosts in the form hostname:port | |
| 232 | $rcmail_config['memcache_hosts'] = null; // e.g. array( 'localhost:11211', '192.168.1.12:11211' ); | |
| 233 | ||
| 4e17e6 | 234 | // check client IP in session athorization |
| aad6e2 | 235 | $rcmail_config['ip_check'] = false; |
| 4e17e6 | 236 | |
| a77cf2 | 237 | // check referer of incoming requests |
| T | 238 | $rcmail_config['referer_check'] = false; |
| 239 | ||
| c170bf | 240 | // X-Frame-Options HTTP header value sent to prevent from Clickjacking. |
| T | 241 | // Possible values: sameorigin|deny. Set to false in order to disable sending them |
| 67eecd | 242 | $rcmail_config['x_frame_options'] = 'sameorigin'; |
| c170bf | 243 | |
| bac7d1 | 244 | // this key is used to encrypt the users imap password which is stored |
| T | 245 | // in the session record (and the client cookie if remember password is enabled). |
| 246 | // please provide a string of exactly 24 chars. | |
| 247 | $rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str'; | |
| 248 | ||
| 2d08c5 | 249 | // Automatically add this domain to user names for login |
| A | 250 | // Only for IMAP servers that require full e-mail addresses for login |
| 251 | // Specify an array with 'host' => 'domain' values to support multiple hosts | |
| 6a642d | 252 | // Supported replacement variables: |
| A | 253 | // %h - user's IMAP hostname |
| 254 | // %n - http hostname ($_SERVER['SERVER_NAME']) | |
| 255 | // %d - domain (http hostname without the first part) | |
| 11be93 | 256 | // %z - IMAP domain (IMAP hostname without the first part) |
| 6a642d | 257 | // For example %n = mail.domain.tld, %d = domain.tld |
| 2d08c5 | 258 | $rcmail_config['username_domain'] = ''; |
| A | 259 | |
| 260 | // This domain will be used to form e-mail addresses of new users | |
| 261 | // Specify an array with 'host' => 'domain' values to support multiple hosts | |
| bb8721 | 262 | // Supported replacement variables: |
| A | 263 | // %h - user's IMAP hostname |
| 264 | // %n - http hostname ($_SERVER['SERVER_NAME']) | |
| 265 | // %d - domain (http hostname without the first part) | |
| 11be93 | 266 | // %z - IMAP domain (IMAP hostname without the first part) |
| bb8721 | 267 | // For example %n = mail.domain.tld, %d = domain.tld |
| 2d08c5 | 268 | $rcmail_config['mail_domain'] = ''; |
| A | 269 | |
| 270 | // Password charset. | |
| 271 | // Use it if your authentication backend doesn't support UTF-8. | |
| 272 | // Defaults to ISO-8859-1 for backward compatibility | |
| 273 | $rcmail_config['password_charset'] = 'ISO-8859-1'; | |
| 274 | ||
| 275 | // How many seconds must pass between emails sent by a user | |
| 276 | $rcmail_config['sendmail_delay'] = 0; | |
| 277 | ||
| 751b22 | 278 | // Maximum number of recipients per message. Default: 0 (no limit) |
| A | 279 | $rcmail_config['max_recipients'] = 0; |
| 280 | ||
| d1851b | 281 | // Maximum allowednumber of members of an address group. Default: 0 (no limit) |
| T | 282 | // If 'max_recipients' is set this value should be less or equal |
| 283 | $rcmail_config['max_group_members'] = 0; | |
| 284 | ||
| 2d08c5 | 285 | // add this user-agent to message headers when sending |
| 6b6f2e | 286 | $rcmail_config['useragent'] = 'Roundcube Webmail/'.RCMAIL_VERSION; |
| 2d08c5 | 287 | |
| A | 288 | // use this name to compose page titles |
| 6b6f2e | 289 | $rcmail_config['product_name'] = 'Roundcube Webmail'; |
| 2d08c5 | 290 | |
| A | 291 | // try to load host-specific configuration |
| 292 | // see http://trac.roundcube.net/wiki/Howto_Config for more details | |
| 293 | $rcmail_config['include_host_config'] = false; | |
| 294 | ||
| 295 | // path to a text file which will be added to each sent message | |
| e019f2 | 296 | // paths are relative to the Roundcube root folder |
| 2d08c5 | 297 | $rcmail_config['generic_message_footer'] = ''; |
| A | 298 | |
| 5852c1 | 299 | // path to a text file which will be added to each sent HTML message |
| e019f2 | 300 | // paths are relative to the Roundcube root folder |
| 5852c1 | 301 | $rcmail_config['generic_message_footer_html'] = ''; |
| A | 302 | |
| 2d08c5 | 303 | // add a received header to outgoing mails containing the creators IP and hostname |
| A | 304 | $rcmail_config['http_received_header'] = false; |
| 305 | ||
| 306 | // Whether or not to encrypt the IP address and the host name | |
| 307 | // these could, in some circles, be considered as sensitive information; | |
| 308 | // however, for the administrator, these could be invaluable help | |
| 309 | // when tracking down issues. | |
| 310 | $rcmail_config['http_received_header_encrypt'] = false; | |
| 311 | ||
| ac8edb | 312 | // This string is used as a delimiter for message headers when sending |
| A | 313 | // a message via mail() function. Leave empty for auto-detection |
| 2d08c5 | 314 | $rcmail_config['mail_header_delimiter'] = NULL; |
| A | 315 | |
| 6b6f2e | 316 | // number of chars allowed for line when wrapping text. |
| T | 317 | // text wrapping is done when composing/sending messages |
| c769c6 | 318 | $rcmail_config['line_length'] = 72; |
| 6b6f2e | 319 | |
| T | 320 | // send plaintext messages as format=flowed |
| 321 | $rcmail_config['send_format_flowed'] = true; | |
| 2d08c5 | 322 | |
| A | 323 | // don't allow these settings to be overriden by the user |
| 324 | $rcmail_config['dont_override'] = array(); | |
| 325 | ||
| 326 | // Set identities access level: | |
| 327 | // 0 - many identities with possibility to edit all params | |
| 328 | // 1 - many identities with possibility to edit all params but not email address | |
| 329 | // 2 - one identity with possibility to edit all params | |
| 330 | // 3 - one identity with possibility to edit all params but not email address | |
| 331 | $rcmail_config['identities_level'] = 0; | |
| 332 | ||
| f7b58a | 333 | // Mimetypes supported by the browser. |
| T | 334 | // attachments of these types will open in a preview window |
| 335 | // either a comma-separated list or an array: 'text/plain,text/html,text/xml,image/jpeg,image/gif,image/png,application/pdf' | |
| 336 | $rcmail_config['client_mimetypes'] = null; # null == default | |
| 337 | ||
| 2d08c5 | 338 | // mime magic database |
| A | 339 | $rcmail_config['mime_magic'] = '/usr/share/misc/magic'; |
| 340 | ||
| 0501b6 | 341 | // path to imagemagick identify binary |
| T | 342 | $rcmail_config['im_identify_path'] = null; |
| 343 | ||
| 344 | // path to imagemagick convert binary | |
| 345 | $rcmail_config['im_convert_path'] = null; | |
| 346 | ||
| 347 | // maximum size of uploaded contact photos in pixel | |
| 348 | $rcmail_config['contact_photo_size'] = 160; | |
| 349 | ||
| 2d08c5 | 350 | // Enable DNS checking for e-mail address validation |
| A | 351 | $rcmail_config['email_dns_check'] = false; |
| 352 | ||
| 353 | // ---------------------------------- | |
| 354 | // PLUGINS | |
| 355 | // ---------------------------------- | |
| 356 | ||
| 357 | // List of active plugins (in plugins/ directory) | |
| 358 | $rcmail_config['plugins'] = array(); | |
| 359 | ||
| 360 | // ---------------------------------- | |
| 361 | // USER INTERFACE | |
| 362 | // ---------------------------------- | |
| 363 | ||
| f52c93 | 364 | // default messages sort column. Use empty value for default server's sorting, |
| T | 365 | // or 'arrival', 'date', 'subject', 'from', 'to', 'size', 'cc' |
| 366 | $rcmail_config['message_sort_col'] = ''; | |
| 2d08c5 | 367 | |
| f52c93 | 368 | // default messages sort order |
| 2d08c5 | 369 | $rcmail_config['message_sort_order'] = 'DESC'; |
| A | 370 | |
| 371 | // These cols are shown in the message list. Available cols are: | |
| 7a2bad | 372 | // subject, from, to, cc, replyto, date, size, status, flag, attachment, 'priority' |
| 4438d6 | 373 | $rcmail_config['list_cols'] = array('subject', 'status', 'from', 'date', 'size', 'flag', 'attachment'); |
| 2d08c5 | 374 | |
| c8ae24 | 375 | // the default locale setting (leave empty for auto-detection) |
| T | 376 | // RFC1766 formatted language name like en_US, de_DE, de_CH, fr_FR, pt_BR |
| 377 | $rcmail_config['language'] = null; | |
| 4e17e6 | 378 | |
| 1cc9e2 | 379 | // use this format for date display (date or strftime format) |
| T | 380 | $rcmail_config['date_format'] = 'Y-m-d'; |
| 381 | ||
| 382 | // give this choice of date formats to the user to select from | |
| 383 | $rcmail_config['date_formats'] = array('Y-m-d', 'd-m-Y', 'Y/m/d', 'm/d/Y', 'd/m/Y', 'd.m.Y', 'j.n.Y'); | |
| 384 | ||
| 385 | // use this format for time display (date or strftime format) | |
| 386 | $rcmail_config['time_format'] = 'H:i'; | |
| 387 | ||
| 388 | // give this choice of time formats to the user to select from | |
| 389 | $rcmail_config['time_formats'] = array('G:i', 'H:i', 'g:i a', 'h:i A'); | |
| 390 | ||
| 391 | // use this format for short date display (derived from date_format and time_format) | |
| 4e17e6 | 392 | $rcmail_config['date_short'] = 'D H:i'; |
| T | 393 | |
| 1cc9e2 | 394 | // use this format for detailed date/time formatting (derived from date_format and time_format) |
| T | 395 | $rcmail_config['date_long'] = 'Y-m-d H:i'; |
| 4e17e6 | 396 | |
| 1966c5 | 397 | // store draft message is this mailbox |
| S | 398 | // leave blank if draft messages should not be stored |
| d08333 | 399 | // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP) |
| 1966c5 | 400 | $rcmail_config['drafts_mbox'] = 'Drafts'; |
| S | 401 | |
| b4b081 | 402 | // store spam messages in this mailbox |
| d08333 | 403 | // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP) |
| b4b081 | 404 | $rcmail_config['junk_mbox'] = 'Junk'; |
| S | 405 | |
| 4e17e6 | 406 | // store sent message is this mailbox |
| T | 407 | // leave blank if sent messages should not be stored |
| d08333 | 408 | // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP) |
| 4e17e6 | 409 | $rcmail_config['sent_mbox'] = 'Sent'; |
| T | 410 | |
| 411 | // move messages to this folder when deleting them | |
| 412 | // leave blank if they should be deleted directly | |
| d08333 | 413 | // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP) |
| 4e17e6 | 414 | $rcmail_config['trash_mbox'] = 'Trash'; |
| T | 415 | |
| fa4cd2 | 416 | // display these folders separately in the mailbox list. |
| 83ce4b | 417 | // these folders will also be displayed with localized names |
| d08333 | 418 | // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP) |
| 4e17e6 | 419 | $rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash'); |
| T | 420 | |
| b2ff3d | 421 | // automatically create the above listed default folders on login |
| 2d08c5 | 422 | $rcmail_config['create_default_folders'] = false; |
| b2ff3d | 423 | |
| c8c1e0 | 424 | // protect the default folders from renames, deletes, and subscription changes |
| 2d08c5 | 425 | $rcmail_config['protect_default_folders'] = true; |
| c8c1e0 | 426 | |
| 2d08c5 | 427 | // if in your system 0 quota means no limit set this option to true |
| A | 428 | $rcmail_config['quota_zero_as_unlimited'] = false; |
| 876b15 | 429 | |
| 996066 | 430 | // Make use of the built-in spell checker. It is based on GoogieSpell. |
| e9ac14 | 431 | // Since Google only accepts connections over https your PHP installatation |
| T | 432 | // requires to be compiled with Open SSL support |
| 2d08c5 | 433 | $rcmail_config['enable_spellcheck'] = true; |
| ed5d29 | 434 | |
| 66df08 | 435 | // Enables spellchecker exceptions dictionary. |
| A | 436 | // Setting it to 'shared' will make the dictionary shared by all users. |
| 437 | $rcmail_config['spellcheck_dictionary'] = false; | |
| 438 | ||
| 5d2b7f | 439 | // Set the spell checking engine. 'googie' is the default. 'pspell' is also available, |
| T | 440 | // but requires the Pspell extensions. When using Nox Spell Server, also set 'googie' here. |
| 441 | $rcmail_config['spellcheck_engine'] = 'googie'; | |
| 442 | ||
| 996066 | 443 | // For a locally installed Nox Spell Server, please specify the URI to call it. |
| T | 444 | // Get Nox Spell Server from http://orangoo.com/labs/?page_id=72 |
| 445 | // Leave empty to use the Google spell checking service, what means | |
| 446 | // that the message content will be sent to Google in order to check spelling | |
| 447 | $rcmail_config['spellcheck_uri'] = ''; | |
| 448 | ||
| 449 | // These languages can be selected for spell checking. | |
| 450 | // Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch'); | |
| 01a8c5 | 451 | // Leave empty for default set of available language. |
| 996066 | 452 | $rcmail_config['spellcheck_languages'] = NULL; |
| T | 453 | |
| 66df08 | 454 | // Makes that words with all letters capitalized will be ignored (e.g. GOOGLE) |
| A | 455 | $rcmail_config['spellcheck_ignore_caps'] = false; |
| 456 | ||
| 457 | // Makes that words with numbers will be ignored (e.g. g00gle) | |
| 458 | $rcmail_config['spellcheck_ignore_nums'] = false; | |
| 459 | ||
| 460 | // Makes that words with symbols will be ignored (e.g. g@@gle) | |
| 461 | $rcmail_config['spellcheck_ignore_syms'] = false; | |
| 462 | ||
| 2d08c5 | 463 | // don't let users set pagesize to more than this value if set |
| A | 464 | $rcmail_config['max_pagesize'] = 200; |
| 967b34 | 465 | |
| 2d08c5 | 466 | // Minimal value of user's 'keep_alive' setting (in seconds) |
| A | 467 | // Must be less than 'session_lifetime' |
| 468 | $rcmail_config['min_keep_alive'] = 60; | |
| 2471d3 | 469 | |
| 4171c5 | 470 | // Enables files upload indicator. Requires APC installed and enabled apc.rfc1867 option. |
| A | 471 | // By default refresh time is set to 1 second. You can set this value to true |
| 472 | // or any integer value indicating number of seconds. | |
| 473 | $rcmail_config['upload_progress'] = false; | |
| 474 | ||
| 63fda8 | 475 | // Specifies for how many seconds the Undo button will be available |
| A | 476 | // after object delete action. Currently used with supporting address book sources. |
| 477 | // Setting it to 0, disables the feature. | |
| 478 | $rcmail_config['undo_timeout'] = 0; | |
| 479 | ||
| 2d08c5 | 480 | // ---------------------------------- |
| A | 481 | // ADDRESSBOOK SETTINGS |
| 482 | // ---------------------------------- | |
| aec82b | 483 | |
| 6153e2 | 484 | // This indicates which type of address book to use. Possible choises: |
| A | 485 | // 'sql' (default) and 'ldap'. |
| 486 | // If set to 'ldap' then it will look at using the first writable LDAP | |
| 4f9c83 | 487 | // address book as the primary address book and it will not display the |
| S | 488 | // SQL address book in the 'Address Book' view. |
| 6153e2 | 489 | $rcmail_config['address_book_type'] = 'sql'; |
| 4f9c83 | 490 | |
| S | 491 | // In order to enable public ldap search, configure an array like the Verisign |
| 492 | // example further below. if you would like to test, simply uncomment the example. | |
| ecf295 | 493 | // Array key must contain only safe characters, ie. a-zA-Z0-9_ |
| 5f25a1 | 494 | $rcmail_config['ldap_public'] = array(); |
| T | 495 | |
| 4f9c83 | 496 | // If you are going to use LDAP for individual address books, you will need to |
| S | 497 | // set 'user_specific' to true and use the variables to generate the appropriate DNs to access it. |
| 498 | // | |
| 499 | // The recommended directory structure for LDAP is to store all the address book entries | |
| 500 | // under the users main entry, e.g.: | |
| 501 | // | |
| 502 | // o=root | |
| 503 | // ou=people | |
| 504 | // uid=user@domain | |
| 3b9a53 | 505 | // mail=contact@contactdomain |
| T | 506 | // |
| 4f9c83 | 507 | // So the base_dn would be uid=%fu,ou=people,o=root |
| S | 508 | // The bind_dn would be the same as based_dn or some super user login. |
| 3b9a53 | 509 | /* |
| f11541 | 510 | * example config for Verisign directory |
| eea43f | 511 | * |
| 3b9a53 | 512 | $rcmail_config['ldap_public']['Verisign'] = array( |
| T | 513 | 'name' => 'Verisign.com', |
| bb8721 | 514 | // Replacement variables supported in host names: |
| A | 515 | // %h - user's IMAP hostname |
| 516 | // %n - http hostname ($_SERVER['SERVER_NAME']) | |
| 517 | // %d - domain (http hostname without the first part) | |
| 11be93 | 518 | // %z - IMAP domain (IMAP hostname without the first part) |
| bb8721 | 519 | // For example %n = mail.domain.tld, %d = domain.tld |
| 3b9a53 | 520 | 'hosts' => array('directory.verisign.com'), |
| T | 521 | 'port' => 389, |
| 1148c6 | 522 | 'use_tls' => false, |
| 0c5210 | 523 | 'ldap_version' => 3, // using LDAPv3 |
| 3b9a53 | 524 | 'user_specific' => false, // If true the base_dn, bind_dn and bind_pass default to the user's IMAP login. |
| T | 525 | // %fu - The full username provided, assumes the username is an email |
| 526 | // address, uses the username_domain value if not an email address. | |
| 527 | // %u - The username prior to the '@'. | |
| 528 | // %d - The domain name after the '@'. | |
| f76765 | 529 | // %dc - The domain name hierarchal string e.g. "dc=test,dc=domain,dc=com" |
| 1148c6 | 530 | // %dn - DN found by ldap search when search_filter/search_base_dn are used |
| 3b9a53 | 531 | 'base_dn' => '', |
| T | 532 | 'bind_dn' => '', |
| 533 | 'bind_pass' => '', | |
| 1148c6 | 534 | // It's possible to bind for an individual address book |
| A | 535 | // The login name is used to search for the DN to bind with |
| 536 | 'search_base_dn' => '', | |
| 537 | 'search_filter' => '', // e.g. '(&(objectClass=posixAccount)(uid=%u))' | |
| 4d982d | 538 | // Optional authentication identifier to be used as SASL authorization proxy |
| A | 539 | // bind_dn need to be empty |
| 540 | 'auth_cid' => '', | |
| 541 | // SASL authentication method (for proxy auth), e.g. DIGEST-MD5 | |
| 542 | 'auth_method' => '', | |
| 5c9d1f | 543 | // Indicates if the addressbook shall be displayed on the list. |
| A | 544 | // With this option enabled you can still search/view contacts. |
| 545 | 'hidden' => false, | |
| 0c5210 | 546 | // Indicates if we can write to the LDAP directory or not. |
| 3b9a53 | 547 | // If writable is true then these fields need to be populated: |
| T | 548 | // LDAP_Object_Classes, required_fields, LDAP_rdn |
| 0c5210 | 549 | 'writable' => false, |
| A | 550 | // To create a new contact these are the object classes to specify |
| 551 | // (or any other classes you wish to use). | |
| 552 | 'LDAP_Object_Classes' => array('top', 'inetOrgPerson'), | |
| 553 | // The RDN field that is used for new entries, this field needs | |
| 554 | // to be one of the search_fields, the base of base_dn is appended | |
| 555 | // to the RDN to insert into the LDAP directory. | |
| 556 | 'LDAP_rdn' => 'mail', | |
| 557 | // The required fields needed to build a new contact as required by | |
| 558 | // the object classes (can include additional fields not required by the object classes). | |
| 559 | 'required_fields' => array('cn', 'sn', 'mail'), | |
| 560 | 'search_fields' => array('mail', 'cn'), // fields to search in | |
| 561 | // mapping of contact fields to directory attributes | |
| 562 | 'fieldmap' => array( | |
| 0501b6 | 563 | // Roundcube => LDAP |
| T | 564 | 'name' => 'cn', |
| 565 | 'surname' => 'sn', | |
| 566 | 'firstname' => 'givenName', | |
| 567 | 'email' => 'mail', | |
| 568 | 'phone:home' => 'homePhone', | |
| 569 | 'phone:work' => 'telephoneNumber', | |
| 570 | 'phone:mobile' => 'mobile', | |
| 571 | 'street' => 'street', | |
| 572 | 'zipcode' => 'postalCode', | |
| 573 | 'locality' => 'l', | |
| 574 | 'country' => 'c', | |
| 575 | 'organization' => 'o', | |
| 576 | ), | |
| 3b9a53 | 577 | 'sort' => 'cn', // The field to sort the listing by. |
| T | 578 | 'scope' => 'sub', // search mode: sub|base|list |
| d1e08f | 579 | 'filter' => '(objectClass=inetOrgPerson)', // used for basic listing (if not empty) and will be &'d with search queries. example: status=act |
| 650601 | 580 | 'fuzzy_search' => true, // server allows wildcard search |
| 15d762 | 581 | 'vlv' => false, // Enable Virtual List View to more efficiently fetch paginated data (if server supports it) |
| 6af7e0 | 582 | 'numsub_filter' => '(objectClass=organizationalUnit)', // with VLV, we also use numSubOrdinates to query the total number of records. Set this filter to get all numSubOrdinates attributes for counting |
| 6039aa | 583 | 'sizelimit' => '0', // Enables you to limit the count of entries fetched. Setting this to 0 means no limit. |
| T | 584 | 'timelimit' => '0', // Sets the number of seconds how long is spend on the search. Setting this to 0 means no limit. |
| d1e08f | 585 | |
| T | 586 | // definition for contact groups (uncomment if no groups are supported) |
| 587 | // for the groups base_dn, the user replacements %fu, %u, $d and %dc work as for base_dn (see above) | |
| 588 | // if the groups base_dn is empty, the contact base_dn is used for the groups as well | |
| 15d762 | 589 | // -> in this case, assure that groups and contacts are separated due to the concernig filters! |
| 6039aa | 590 | 'groups' => array( |
| d1e08f | 591 | 'base_dn' => '', |
| 6039aa | 592 | 'filter' => '(objectClass=groupOfNames)', |
| d1e08f | 593 | 'object_classes' => array("top", "groupOfNames"), |
| 6039aa | 594 | ), |
| 93c018 | 595 | ); |
| 3b9a53 | 596 | */ |
| d1d2c4 | 597 | |
| 2c8e84 | 598 | // An ordered array of the ids of the addressbooks that should be searched |
| T | 599 | // when populating address autocomplete fields server-side. ex: array('sql','Verisign'); |
| 600 | $rcmail_config['autocomplete_addressbooks'] = array('sql'); | |
| 601 | ||
| c296b8 | 602 | // The minimum number of characters required to be typed in an autocomplete field |
| A | 603 | // before address books will be searched. Most useful for LDAP directories that |
| 604 | // may need to do lengthy results building given overly-broad searches | |
| 605 | $rcmail_config['autocomplete_min_length'] = 1; | |
| 606 | ||
| 0213f8 | 607 | // Number of parallel autocomplete requests. |
| A | 608 | // If there's more than one address book, n parallel (async) requests will be created, |
| 609 | // where each request will search in one address book. By default (0), all address | |
| 610 | // books are searched in one request. | |
| 611 | $rcmail_config['autocomplete_threads'] = 0; | |
| 612 | ||
| 613 | // Max. numer of entries in autocomplete popup. Default: 15. | |
| 614 | $rcmail_config['autocomplete_max'] = 15; | |
| 615 | ||
| 0501b6 | 616 | // show address fields in this order |
| T | 617 | // available placeholders: {street}, {locality}, {zipcode}, {country}, {region} |
| 618 | $rcmail_config['address_template'] = '{street}<br/>{locality} {zipcode}<br/>{country} {region}'; | |
| 619 | ||
| 2d08c5 | 620 | // ---------------------------------- |
| A | 621 | // USER PREFERENCES |
| 622 | // ---------------------------------- | |
| 4e17e6 | 623 | |
| e55ab0 | 624 | // Use this charset as fallback for message decoding |
| A | 625 | $rcmail_config['default_charset'] = 'ISO-8859-1'; |
| 626 | ||
| 67effe | 627 | // skin name: folder from skins/ |
| A | 628 | $rcmail_config['skin'] = 'default'; |
| e58df3 | 629 | |
| 4e17e6 | 630 | // show up to X items in list view |
| T | 631 | $rcmail_config['pagesize'] = 40; |
| 632 | ||
| 633 | // use this timezone to display date/time | |
| c8ae24 | 634 | $rcmail_config['timezone'] = 'auto'; |
| 4e17e6 | 635 | |
| 5349b7 | 636 | // is daylight saving On? |
| d7d663 | 637 | $rcmail_config['dst_active'] = (bool)date('I'); |
| 4647e1 | 638 | |
| 4e17e6 | 639 | // prefer displaying HTML messages |
| 2d08c5 | 640 | $rcmail_config['prefer_html'] = true; |
| 4e17e6 | 641 | |
| 2a4135 | 642 | // display remote inline images |
| A | 643 | // 0 - Never, always ask |
| 644 | // 1 - Ask if sender is not in address book | |
| 645 | // 2 - Always show inline images | |
| 646 | $rcmail_config['show_images'] = 0; | |
| 712b30 | 647 | |
| b19097 | 648 | // compose html formatted messages by default |
| 868deb | 649 | // 0 - never, 1 - always, 2 - on reply to HTML message only |
| A | 650 | $rcmail_config['htmleditor'] = 0; |
| b19097 | 651 | |
| 30233b | 652 | // show pretty dates as standard |
| 2d08c5 | 653 | $rcmail_config['prettydate'] = true; |
| 4e17e6 | 654 | |
| d656f1 | 655 | // save compose message every 300 seconds (5min) |
| T | 656 | $rcmail_config['draft_autosave'] = 300; |
| 0566ad | 657 | |
| b19097 | 658 | // default setting if preview pane is enabled |
| 2d08c5 | 659 | $rcmail_config['preview_pane'] = false; |
| b19097 | 660 | |
| bc4960 | 661 | // Mark as read when viewed in preview pane (delay in seconds) |
| T | 662 | // Set to -1 if messages in preview pane should not be marked as read |
| 663 | $rcmail_config['preview_pane_mark_read'] = 0; | |
| 664 | ||
| eaa394 | 665 | // Clear Trash on logout |
| 2d08c5 | 666 | $rcmail_config['logout_purge'] = false; |
| eaa394 | 667 | |
| A | 668 | // Compact INBOX on logout |
| 2d08c5 | 669 | $rcmail_config['logout_expunge'] = false; |
| 50c753 | 670 | |
| 166b61 | 671 | // Display attached images below the message body |
| 2d08c5 | 672 | $rcmail_config['inline_images'] = true; |
| 5e0045 | 673 | |
| ffae15 | 674 | // Encoding of long/non-ascii attachment names: |
| A | 675 | // 0 - Full RFC 2231 compatible |
| 676 | // 1 - RFC 2047 for 'name' and RFC 2231 for 'filename' parameter (Thunderbird's default) | |
| 677 | // 2 - Full 2047 compatible | |
| 21c277 | 678 | $rcmail_config['mime_param_folding'] = 1; |
| ffae15 | 679 | |
| 2d08c5 | 680 | // Set true if deleted messages should not be displayed |
| 2b5852 | 681 | // This will make the application run slower |
| 2d08c5 | 682 | $rcmail_config['skip_deleted'] = false; |
| 2b5852 | 683 | |
| A | 684 | // Set true to Mark deleted messages as read as well as deleted |
| 685 | // False means that a message's read status is not affected by marking it as deleted | |
| 2d08c5 | 686 | $rcmail_config['read_when_deleted'] = true; |
| 2b5852 | 687 | |
| ca8a17 | 688 | // Set to true to never delete messages immediately |
| A | 689 | // Use 'Purge' to remove messages marked as deleted |
| 2d08c5 | 690 | $rcmail_config['flag_for_deletion'] = false; |
| 2b5852 | 691 | |
| 95d90f | 692 | // Default interval for keep-alive/check-recent requests (in seconds) |
| A | 693 | // Must be greater than or equal to 'min_keep_alive' and less than 'session_lifetime' |
| 694 | $rcmail_config['keep_alive'] = 60; | |
| 695 | ||
| 2fd975 | 696 | // If true all folders will be checked for recent messages |
| 2d08c5 | 697 | $rcmail_config['check_all_folders'] = false; |
| 2fd975 | 698 | |
| e54bb7 | 699 | // If true, after message delete/move, the next message will be displayed |
| 2d08c5 | 700 | $rcmail_config['display_next'] = false; |
| e54bb7 | 701 | |
| f52c93 | 702 | // 0 - Do not expand threads |
| T | 703 | // 1 - Expand all threads automatically |
| 704 | // 2 - Expand only threads with unread messages | |
| 705 | $rcmail_config['autoexpand_threads'] = 0; | |
| 1cead0 | 706 | |
| 50f56d | 707 | // When replying place cursor above original message (top posting) |
| 2d08c5 | 708 | $rcmail_config['top_posting'] = false; |
| 50f56d | 709 | |
| 0207c4 | 710 | // When replying strip original signature from message |
| 2d08c5 | 711 | $rcmail_config['strip_existing_sig'] = true; |
| 0207c4 | 712 | |
| 50f56d | 713 | // Show signature: |
| 0207c4 | 714 | // 0 - Never |
| T | 715 | // 1 - Always |
| 50f56d | 716 | // 2 - New messages only |
| 0207c4 | 717 | // 3 - Forwards and Replies only |
| T | 718 | $rcmail_config['show_sig'] = 1; |
| 719 | ||
| 720 | // When replying or forwarding place sender's signature above existing message | |
| 2d08c5 | 721 | $rcmail_config['sig_above'] = false; |
| 50f56d | 722 | |
| 47ad83 | 723 | // Use MIME encoding (quoted-printable) for 8bit characters in message body |
| 2d08c5 | 724 | $rcmail_config['force_7bit'] = false; |
| 47ad83 | 725 | |
| b975da | 726 | // Defaults of the search field configuration. |
| T | 727 | // The array can contain a per-folder list of header fields which should be considered when searching |
| 728 | // The entry with key '*' stands for all folders which do not have a specific list set. | |
| 729 | // Please note that folder names should to be in sync with $rcmail_config['default_imap_folders'] | |
| 730 | $rcmail_config['search_mods'] = null; // Example: array('*' => array('subject'=>1, 'from'=>1), 'Sent' => array('subject'=>1, 'to'=>1)); | |
| 731 | ||
| 3cacf9 | 732 | // Defaults of the addressbook search field configuration. |
| A | 733 | $rcmail_config['addressbook_search_mods'] = null; // Example: array('name'=>1, 'firstname'=>1, 'surname'=>1, 'email'=>1, '*'=>1); |
| 734 | ||
| b7f952 | 735 | // 'Delete always' |
| A | 736 | // This setting reflects if mail should be always deleted |
| 737 | // when moving to Trash fails. This is necessary in some setups | |
| 738 | // when user is over quota and Trash is included in the quota. | |
| 739 | $rcmail_config['delete_always'] = false; | |
| 740 | ||
| f22ea7 | 741 | // Behavior if a received message requests a message delivery notification (read receipt) |
| A | 742 | // 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask) |
| 743 | // 3 = send automatically if sender is in addressbook, otherwise ask the user | |
| 744 | // 4 = send automatically if sender is in addressbook, otherwise ignore | |
| 745 | $rcmail_config['mdn_requests'] = 0; | |
| b25dfd | 746 | |
| f22ea7 | 747 | // Return receipt checkbox default state |
| A | 748 | $rcmail_config['mdn_default'] = 0; |
| 749 | ||
| 750 | // Delivery Status Notification checkbox default state | |
| 751 | $rcmail_config['dsn_default'] = 0; | |
| 752 | ||
| eeb85f | 753 | // Place replies in the folder of the message being replied to |
| A | 754 | $rcmail_config['reply_same_folder'] = false; |
| 755 | ||
| a509bb | 756 | // Sets default mode of Forward feature to "forward as attachment" |
| A | 757 | $rcmail_config['forward_attachment'] = false; |
| 758 | ||
| d73448 | 759 | // Defines address book (internal index) to which new contacts will be added |
| A | 760 | // By default it is the first writeable addressbook. |
| 761 | // Note: Use '0' for built-in address book. | |
| 762 | $rcmail_config['default_addressbook'] = null; | |
| 763 | ||
| 1d5779 | 764 | // Enables spell checking before sending a message. |
| A | 765 | $rcmail_config['spellcheck_before_send'] = false; |
| 766 | ||
| f22ea7 | 767 | // end of config file |
