| commit | author | age | ||
| 4e17e6 | 1 | <?php |
| T | 2 | |
| 3 | /* | |
| 4 | +-----------------------------------------------------------------------+ | |
| acc005 | 5 | | Main configuration file with default settings | |
| 4e17e6 | 6 | | | |
| e019f2 | 7 | | This file is part of the Roundcube Webmail client | |
| acc005 | 8 | | Copyright (C) 2005-2013, The Roundcube Dev Team | |
| 7fe381 | 9 | | | |
| T | 10 | | Licensed under the GNU General Public License version 3 or | |
| 11 | | any later version with exceptions for skins & plugins. | | |
| 12 | | See the README file for a full license statement. | | |
| 4e17e6 | 13 | +-----------------------------------------------------------------------+ |
| T | 14 | */ |
| 15 | ||
| acc005 | 16 | $config = array(); |
| AM | 17 | |
| 18 | // ---------------------------------- | |
| 19 | // SQL DATABASE | |
| 20 | // ---------------------------------- | |
| 21 | ||
| 22 | // Database connection string (DSN) for read+write operations | |
| 23 | // Format (compatible with PEAR MDB2): db_provider://user:password@host/database | |
| 24 | // Currently supported db_providers: mysql, pgsql, sqlite, mssql or sqlsrv | |
| 25 | // For examples see http://pear.php.net/manual/en/package.database.mdb2.intro-dsn.php | |
| 26 | // NOTE: for SQLite use absolute path: 'sqlite:////full/path/to/sqlite.db?mode=0646' | |
| 9bacb2 | 27 | $config['db_dsnw'] = 'mysql://roundcube:@localhost/roundcubemail'; |
| acc005 | 28 | |
| AM | 29 | // Database DSN for read-only operations (if empty write database will be used) |
| 30 | // useful for database replication | |
| 31 | $config['db_dsnr'] = ''; | |
| 32 | ||
| 92d18c | 33 | // Disable the use of already established dsnw connections for subsequent reads |
| TB | 34 | $config['db_dsnw_noread'] = false; |
| 35 | ||
| acc005 | 36 | // use persistent db-connections |
| AM | 37 | // beware this will not "always" work as expected |
| 38 | // see: http://www.php.net/manual/en/features.persistent-connections.php | |
| 39 | $config['db_persistent'] = false; | |
| 40 | ||
| 41 | // you can define specific table (and sequence) names prefix | |
| 42 | $config['db_prefix'] = ''; | |
| 43 | ||
| a69f99 | 44 | // Mapping of table names and connections to use for ALL operations. |
| TB | 45 | // This can be used in a setup with replicated databases and a DB master |
| 46 | // where read/write access to cache tables should not go to master. | |
| 47 | $config['db_table_dsn'] = array( | |
| 48 | // 'cache' => 'r', | |
| 49 | // 'cache_index' => 'r', | |
| 50 | // 'cache_thread' => 'r', | |
| 51 | // 'cache_messages' => 'r', | |
| 52 | ); | |
| 53 | ||
| 4e17e6 | 54 | |
| 2d08c5 | 55 | // ---------------------------------- |
| A | 56 | // LOGGING/DEBUGGING |
| 57 | // ---------------------------------- | |
| 58 | ||
| 5be6dc | 59 | // system error reporting, sum of: 1 = log; 4 = show |
| acc005 | 60 | $config['debug_level'] = 1; |
| 4e17e6 | 61 | |
| b77d0d | 62 | // log driver: 'syslog' or 'file'. |
| acc005 | 63 | $config['log_driver'] = 'file'; |
| b77d0d | 64 | |
| 0ad27c | 65 | // date format for log entries |
| A | 66 | // (read http://php.net/manual/en/function.date.php for all format characters) |
| acc005 | 67 | $config['log_date_format'] = 'd-M-Y H:i:s O'; |
| 0ad27c | 68 | |
| 561f5e | 69 | // length of the session ID to prepend each log line with |
| TB | 70 | // set to 0 to avoid session IDs being logged. |
| 71 | $config['log_session_id'] = 8; | |
| 72 | ||
| b77d0d | 73 | // Syslog ident string to use, if using the 'syslog' log driver. |
| acc005 | 74 | $config['syslog_id'] = 'roundcube'; |
| b77d0d | 75 | |
| A | 76 | // Syslog facility to use, if using the 'syslog' log driver. |
| 77 | // For possible values see installer or http://php.net/manual/en/function.openlog.php | |
| acc005 | 78 | $config['syslog_facility'] = LOG_USER; |
| b77d0d | 79 | |
| 3786a4 | 80 | // Activate this option if logs should be written to per-user directories. |
| TB | 81 | // Data will only be logged if a directry <log_dir>/<username>/ exists and is writable. |
| 82 | $config['per_user_logging'] = false; | |
| 83 | ||
| 3e3429 | 84 | // Log sent messages to <log_dir>/sendmail or to syslog |
| acc005 | 85 | $config['smtp_log'] = true; |
| b77d0d | 86 | |
| 060467 | 87 | // Log successful/failed logins to <log_dir>/userlogins or to syslog |
| acc005 | 88 | $config['log_logins'] = false; |
| b77d0d | 89 | |
| fcc7f8 | 90 | // Log session authentication errors to <log_dir>/session or to syslog |
| acc005 | 91 | $config['log_session'] = false; |
| fcc7f8 | 92 | |
| 2d08c5 | 93 | // Log SQL queries to <log_dir>/sql or to syslog |
| acc005 | 94 | $config['sql_debug'] = false; |
| cc97ea | 95 | |
| 2d08c5 | 96 | // Log IMAP conversation to <log_dir>/imap or to syslog |
| acc005 | 97 | $config['imap_debug'] = false; |
| 6dc026 | 98 | |
| 2d08c5 | 99 | // Log LDAP conversation to <log_dir>/ldap or to syslog |
| acc005 | 100 | $config['ldap_debug'] = false; |
| cc9570 | 101 | |
| 2d08c5 | 102 | // Log SMTP conversation to <log_dir>/smtp or to syslog |
| acc005 | 103 | $config['smtp_debug'] = false; |
| f5d61d | 104 | |
| 2d08c5 | 105 | // ---------------------------------- |
| A | 106 | // IMAP |
| 107 | // ---------------------------------- | |
| 4e17e6 | 108 | |
| 768e33 | 109 | // The mail host chosen to perform the log-in. |
| AM | 110 | // Leave blank to show a textbox at login, give a list of hosts |
| 42b113 | 111 | // to display a pulldown menu or set one host as string. |
| f86e8f | 112 | // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls:// |
| bb8721 | 113 | // Supported replacement variables: |
| d359dc | 114 | // %n - hostname ($_SERVER['SERVER_NAME']) |
| B | 115 | // %t - hostname without the first part |
| 116 | // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part) | |
| b04c51 | 117 | // %s - domain name after the '@' from e-mail address provided at login screen |
| d359dc | 118 | // For example %n = mail.domain.tld, %t = domain.tld |
| 768e33 | 119 | // WARNING: After hostname change update of mail_host column in users table is |
| AM | 120 | // required to match old user data records with the new host. |
| 9bacb2 | 121 | $config['default_host'] = 'localhost'; |
| 4e17e6 | 122 | |
| 42b113 | 123 | // TCP port used for IMAP connections |
| acc005 | 124 | $config['default_port'] = 143; |
| 42b113 | 125 | |
| 00f347 | 126 | // IMAP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or null to use |
| 4dd417 | 127 | // best server supported one) |
| acc005 | 128 | $config['imap_auth_type'] = null; |
| b026c3 | 129 | |
| 109bcc | 130 | // IMAP socket context options |
| AM | 131 | // See http://php.net/manual/en/context.ssl.php |
| 132 | // The example below enables server certificate validation | |
| 133 | //$config['imap_conn_options'] = array( | |
| 134 | // 'ssl' => array( | |
| 135 | // 'verify_peer' => true, | |
| 136 | // 'verify_depth' => 3, | |
| 137 | // 'cafile' => '/etc/openssl/certs/ca.crt', | |
| 138 | // ), | |
| 139 | // ); | |
| 140 | $config['imap_conn_options'] = null; | |
| 141 | ||
| 142 | // IMAP connection timeout, in seconds. Default: 0 (use default_socket_timeout) | |
| 143 | $config['imap_timeout'] = 0; | |
| 144 | ||
| 145 | // Optional IMAP authentication identifier to be used as authorization proxy | |
| 146 | $config['imap_auth_cid'] = null; | |
| 147 | ||
| 148 | // Optional IMAP authentication password to be used for imap_auth_cid | |
| 149 | $config['imap_auth_pw'] = null; | |
| 150 | ||
| 00290a | 151 | // If you know your imap's folder delimiter, you can specify it here. |
| A | 152 | // Otherwise it will be determined automatically |
| acc005 | 153 | $config['imap_delimiter'] = null; |
| 030c84 | 154 | |
| 00290a | 155 | // If IMAP server doesn't support NAMESPACE extension, but you're |
| A | 156 | // using shared folders or personal root folder is non-empty, you'll need to |
| 157 | // set these options. All can be strings or arrays of strings. | |
| e3af1f | 158 | // Folders need to be ended with directory separator, e.g. "INBOX." |
| A | 159 | // (special directory "~" is an exception to this rule) |
| 02491a | 160 | // These can be used also to overwrite server's namespaces |
| acc005 | 161 | $config['imap_ns_personal'] = null; |
| AM | 162 | $config['imap_ns_other'] = null; |
| 163 | $config['imap_ns_shared'] = null; | |
| 00290a | 164 | |
| d8c440 | 165 | // By default IMAP capabilities are readed after connection to IMAP server |
| A | 166 | // In some cases, e.g. when using IMAP proxy, there's a need to refresh the list |
| 167 | // after login. Set to True if you've got this case. | |
| acc005 | 168 | $config['imap_force_caps'] = false; |
| d8c440 | 169 | |
| f75f65 | 170 | // By default list of subscribed folders is determined using LIST-EXTENDED |
| A | 171 | // extension if available. Some servers (dovecot 1.x) returns wrong results |
| 172 | // for shared namespaces in this case. http://trac.roundcube.net/ticket/1486225 | |
| 173 | // Enable this option to force LSUB command usage instead. | |
| ed3e51 | 174 | // Deprecated: Use imap_disabled_caps = array('LIST-EXTENDED') |
| acc005 | 175 | $config['imap_force_lsub'] = false; |
| f75f65 | 176 | |
| 3c5489 | 177 | // Some server configurations (e.g. Courier) doesn't list folders in all namespaces |
| AM | 178 | // Enable this option to force listing of folders in all namespaces |
| acc005 | 179 | $config['imap_force_ns'] = false; |
| 3c5489 | 180 | |
| ed3e51 | 181 | // List of disabled imap extensions. |
| AM | 182 | // Use if your IMAP server has broken implementation of some feature |
| 183 | // and you can't remove it from CAPABILITY string on server-side. | |
| 184 | // For example UW-IMAP server has broken ESEARCH. | |
| 185 | // Note: Because the list is cached, re-login is required after change. | |
| 7c6848 | 186 | $config['imap_disabled_caps'] = array(); |
| a1fe6b | 187 | |
| 561f5e | 188 | // Log IMAP session identifers after each IMAP login. |
| TB | 189 | // This is used to relate IMAP session with Roundcube user sessions |
| 190 | $config['imap_log_session'] = false; | |
| 191 | ||
| 8edb3d | 192 | // Type of IMAP indexes cache. Supported values: 'db', 'apc' and 'memcache'. |
| acc005 | 193 | $config['imap_cache'] = null; |
| 5cf5ee | 194 | |
| A | 195 | // Enables messages cache. Only 'db' cache is supported. |
| 769829 | 196 | // This requires an IMAP server that supports QRESYNC and CONDSTORE |
| AM | 197 | // extensions (RFC7162). See synchronize() in program/lib/Roundcube/rcube_imap_cache.php |
| 198 | // for further info, or if you experience syncing problems. | |
| acc005 | 199 | $config['messages_cache'] = false; |
| 5cf5ee | 200 | |
| 61ccdf | 201 | // Lifetime of IMAP indexes cache. Possible units: s, m, h, d, w |
| acc005 | 202 | $config['imap_cache_ttl'] = '10d'; |
| 61ccdf | 203 | |
| 67ac6e | 204 | // Lifetime of messages cache. Possible units: s, m, h, d, w |
| acc005 | 205 | $config['messages_cache_ttl'] = '10d'; |
| 5cf5ee | 206 | |
| 21601b | 207 | // Maximum cached message size in kilobytes. |
| AM | 208 | // Note: On MySQL this should be less than (max_allowed_packet - 30%) |
| 209 | $config['messages_cache_threshold'] = 50; | |
| 210 | ||
| 211 | ||
| 2d08c5 | 212 | // ---------------------------------- |
| A | 213 | // SMTP |
| 214 | // ---------------------------------- | |
| f88d41 | 215 | |
| c3b676 | 216 | // SMTP server host (for sending mails). |
| 2d08c5 | 217 | // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls:// |
| c3b676 | 218 | // If left blank, the PHP mail() function is used |
| bb8721 | 219 | // Supported replacement variables: |
| A | 220 | // %h - user's IMAP hostname |
| d359dc | 221 | // %n - hostname ($_SERVER['SERVER_NAME']) |
| B | 222 | // %t - hostname without the first part |
| 223 | // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part) | |
| 11be93 | 224 | // %z - IMAP domain (IMAP hostname without the first part) |
| d359dc | 225 | // For example %n = mail.domain.tld, %t = domain.tld |
| acc005 | 226 | $config['smtp_server'] = ''; |
| 4e17e6 | 227 | |
| e52aae | 228 | // SMTP port (default is 25; use 587 for STARTTLS or 465 for the |
| T | 229 | // deprecated SSL over SMTP (aka SMTPS)) |
| acc005 | 230 | $config['smtp_port'] = 25; |
| 968bdc | 231 | |
| e019f2 | 232 | // SMTP username (if required) if you use %u as the username Roundcube |
| d206c1 | 233 | // will use the current username for login |
| acc005 | 234 | $config['smtp_user'] = ''; |
| 4e17e6 | 235 | |
| e019f2 | 236 | // SMTP password (if required) if you use %p as the password Roundcube |
| d206c1 | 237 | // will use the current user's password for login |
| acc005 | 238 | $config['smtp_pass'] = ''; |
| 4e17e6 | 239 | |
| d206c1 | 240 | // SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use |
| S | 241 | // best server supported one) |
| acc005 | 242 | $config['smtp_auth_type'] = ''; |
| d206c1 | 243 | |
| 63d4d6 | 244 | // Optional SMTP authentication identifier to be used as authorization proxy |
| acc005 | 245 | $config['smtp_auth_cid'] = null; |
| 63d4d6 | 246 | |
| a1fe6b | 247 | // Optional SMTP authentication password to be used for smtp_auth_cid |
| acc005 | 248 | $config['smtp_auth_pw'] = null; |
| a39212 | 249 | |
| aca3d2 | 250 | // SMTP HELO host |
| S | 251 | // Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages |
| 252 | // Leave this blank and you will get the server variable 'server_name' or | |
| b07426 | 253 | // localhost if that isn't defined. |
| acc005 | 254 | $config['smtp_helo_host'] = ''; |
| aca3d2 | 255 | |
| bc94e2 | 256 | // SMTP connection timeout, in seconds. Default: 0 (use default_socket_timeout) |
| cd9e41 | 257 | // Note: There's a known issue where using ssl connection with |
| AM | 258 | // timeout > 0 causes connection errors (https://bugs.php.net/bug.php?id=54511) |
| acc005 | 259 | $config['smtp_timeout'] = 0; |
| b07426 | 260 | |
| 357f9c | 261 | // SMTP socket context options |
| AM | 262 | // See http://php.net/manual/en/context.ssl.php |
| 263 | // The example below enables server certificate validation, and | |
| 264 | // requires 'smtp_timeout' to be non zero. | |
| 265 | // $config['smtp_conn_options'] = array( | |
| 266 | // 'ssl' => array( | |
| 109bcc | 267 | // 'verify_peer' => true, |
| AM | 268 | // 'verify_depth' => 3, |
| 269 | // 'cafile' => '/etc/openssl/certs/ca.crt', | |
| 357f9c | 270 | // ), |
| AM | 271 | // ); |
| 272 | $config['smtp_conn_options'] = null; | |
| 273 | ||
| 109bcc | 274 | |
| b07426 | 275 | // ---------------------------------- |
| AM | 276 | // LDAP |
| 277 | // ---------------------------------- | |
| 278 | ||
| 279 | // Type of LDAP cache. Supported values: 'db', 'apc' and 'memcache'. | |
| acc005 | 280 | $config['ldap_cache'] = 'db'; |
| b07426 | 281 | |
| AM | 282 | // Lifetime of LDAP cache. Possible units: s, m, h, d, w |
| acc005 | 283 | $config['ldap_cache_ttl'] = '10m'; |
| f07d23 | 284 | |
| 2d08c5 | 285 | // ---------------------------------- |
| A | 286 | // SYSTEM |
| 287 | // ---------------------------------- | |
| 64608b | 288 | |
| 2d08c5 | 289 | // THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA. |
| A | 290 | // ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING! |
| acc005 | 291 | $config['enable_installer'] = false; |
| 4e17e6 | 292 | |
| e04e31 | 293 | // don't allow these settings to be overriden by the user |
| acc005 | 294 | $config['dont_override'] = array(); |
| e04e31 | 295 | |
| d01f9f | 296 | // List of disabled UI elements/actions |
| AM | 297 | $config['disabled_actions'] = array(); |
| 298 | ||
| 4a05e8 | 299 | // define which settings should be listed under the 'advanced' block |
| TB | 300 | // which is hidden by default |
| 301 | $config['advanced_prefs'] = array(); | |
| 302 | ||
| c04b23 | 303 | // provide an URL where a user can get support for this Roundcube installation |
| T | 304 | // PLEASE DO NOT LINK TO THE ROUNDCUBE.NET WEBSITE HERE! |
| acc005 | 305 | $config['support_url'] = ''; |
| c04b23 | 306 | |
| T | 307 | // replace Roundcube logo with this image |
| 308 | // specify an URL relative to the document root of this Roundcube installation | |
| d81d69 | 309 | // an array can be used to specify different logos for specific template files, '*' for default logo |
| P | 310 | // for example array("*" => "/images/roundcube_logo.png", "messageprint" => "/images/roundcube_logo_print.png") |
| acc005 | 311 | $config['skin_logo'] = null; |
| c04b23 | 312 | |
| T | 313 | // automatically create a new Roundcube user when log-in the first time. |
| 314 | // a new user will be created once the IMAP login succeeds. | |
| 315 | // set to false if only registered users can use this service | |
| acc005 | 316 | $config['auto_create_user'] = true; |
| c04b23 | 317 | |
| 565c47 | 318 | // Enables possibility to log in using email address from user identities |
| acc005 | 319 | $config['user_aliases'] = false; |
| 565c47 | 320 | |
| 2d08c5 | 321 | // use this folder to store log files (must be writeable for apache user) |
| A | 322 | // This is used by the 'file' log driver. |
| 57def0 | 323 | $config['log_dir'] = RCUBE_INSTALL_PATH . 'logs/'; |
| d559cb | 324 | |
| 2d08c5 | 325 | // use this folder to store temp files (must be writeable for apache user) |
| 57def0 | 326 | $config['temp_dir'] = RCUBE_INSTALL_PATH . 'temp/'; |
| 19862b | 327 | |
| de8687 | 328 | // expire files in temp_dir after 48 hours |
| DC | 329 | // possible units: s, m, h, d, w |
| 330 | $config['temp_dir_ttl'] = '48h'; | |
| 331 | ||
| 2d08c5 | 332 | // enforce connections over https |
| A | 333 | // with this option enabled, all non-secure connections will be redirected. |
| 334 | // set the port for the ssl connection as value of this option if it differs from the default 443 | |
| acc005 | 335 | $config['force_https'] = false; |
| acb08f | 336 | |
| 00e18b | 337 | // tell PHP that it should work as under secure connection |
| A | 338 | // even if it doesn't recognize it as secure ($_SERVER['HTTPS'] is not set) |
| 339 | // e.g. when you're running Roundcube behind a https proxy | |
| 377bc6 | 340 | // this option is mutually exclusive to 'force_https' and only either one of them should be set to true. |
| acc005 | 341 | $config['use_https'] = false; |
| 00e18b | 342 | |
| 1cca4f | 343 | // Allow browser-autocompletion on login form. |
| A | 344 | // 0 - disabled, 1 - username and host only, 2 - username, host, password |
| acc005 | 345 | $config['login_autocomplete'] = 0; |
| fbe24e | 346 | |
| c72325 | 347 | // Forces conversion of logins to lower case. |
| AM | 348 | // 0 - disabled, 1 - only domain part, 2 - domain and local part. |
| df95e7 | 349 | // If users authentication is case-insensitive this must be enabled. |
| AM | 350 | // Note: After enabling it all user records need to be updated, e.g. with query: |
| 351 | // UPDATE users SET username = LOWER(username); | |
| acc005 | 352 | $config['login_lc'] = 2; |
| ae39c4 | 353 | |
| 95d90f | 354 | // Includes should be interpreted as PHP files |
| acc005 | 355 | $config['skin_include_php'] = false; |
| fd8c50 | 356 | |
| b6267d | 357 | // display software version on login screen |
| acc005 | 358 | $config['display_version'] = false; |
| b6267d | 359 | |
| 95d90f | 360 | // Session lifetime in minutes |
| acc005 | 361 | $config['session_lifetime'] = 10; |
| 7902df | 362 | |
| ae7027 | 363 | // Session domain: .example.org |
| acc005 | 364 | $config['session_domain'] = ''; |
| cf2da2 | 365 | |
| ae7027 | 366 | // Session name. Default: 'roundcube_sessid' |
| acc005 | 367 | $config['session_name'] = null; |
| bd34ca | 368 | |
| 8d2963 | 369 | // Session authentication cookie name. Default: 'roundcube_sessauth' |
| TB | 370 | $config['session_auth_name'] = null; |
| 371 | ||
| ae7027 | 372 | // Session path. Defaults to PHP session.cookie_path setting. |
| acc005 | 373 | $config['session_path'] = null; |
| ae7027 | 374 | |
| 42de33 | 375 | // Backend to use for session storage. Can either be 'db' (default), 'memcache' or 'php' |
| TB | 376 | // If set to 'memcache', a list of servers need to be specified in 'memcache_hosts' |
| 63e992 | 377 | // Make sure the Memcache extension (http://pecl.php.net/package/memcache) version >= 2.0.0 is installed |
| 42de33 | 378 | // Setting this value to 'php' will use the default session save handler configured in PHP |
| acc005 | 379 | $config['session_storage'] = 'db'; |
| 63e992 | 380 | |
| T | 381 | // Use these hosts for accessing memcached |
| 71ee56 | 382 | // Define any number of hosts in the form of hostname:port or unix:///path/to/socket.file |
| acc005 | 383 | $config['memcache_hosts'] = null; // e.g. array( 'localhost:11211', '192.168.1.12:11211', 'unix:///var/tmp/memcached.sock' ); |
| 63e992 | 384 | |
| 3fca23 | 385 | // check client IP in session authorization |
| acc005 | 386 | $config['ip_check'] = false; |
| 4e17e6 | 387 | |
| ef721f | 388 | // List of trusted proxies |
| FE | 389 | // X_FORWARDED_* and X_REAL_IP headers are only accepted from these IPs |
| 390 | $config['proxy_whitelist'] = array(); | |
| 391 | ||
| a77cf2 | 392 | // check referer of incoming requests |
| acc005 | 393 | $config['referer_check'] = false; |
| a77cf2 | 394 | |
| c170bf | 395 | // X-Frame-Options HTTP header value sent to prevent from Clickjacking. |
| T | 396 | // Possible values: sameorigin|deny. Set to false in order to disable sending them |
| acc005 | 397 | $config['x_frame_options'] = 'sameorigin'; |
| c170bf | 398 | |
| bac7d1 | 399 | // this key is used to encrypt the users imap password which is stored |
| T | 400 | // in the session record (and the client cookie if remember password is enabled). |
| 401 | // please provide a string of exactly 24 chars. | |
| acc005 | 402 | $config['des_key'] = 'rcmail-!24ByteDESkey*Str'; |
| bac7d1 | 403 | |
| 2d08c5 | 404 | // Automatically add this domain to user names for login |
| A | 405 | // Only for IMAP servers that require full e-mail addresses for login |
| 406 | // Specify an array with 'host' => 'domain' values to support multiple hosts | |
| 6a642d | 407 | // Supported replacement variables: |
| A | 408 | // %h - user's IMAP hostname |
| d359dc | 409 | // %n - hostname ($_SERVER['SERVER_NAME']) |
| B | 410 | // %t - hostname without the first part |
| 411 | // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part) | |
| 11be93 | 412 | // %z - IMAP domain (IMAP hostname without the first part) |
| d359dc | 413 | // For example %n = mail.domain.tld, %t = domain.tld |
| acc005 | 414 | $config['username_domain'] = ''; |
| 2d08c5 | 415 | |
| 96f59c | 416 | // Force domain configured in username_domain to be used for login. |
| AM | 417 | // Any domain in username will be replaced by username_domain. |
| 418 | $config['username_domain_forced'] = false; | |
| 419 | ||
| 2d08c5 | 420 | // This domain will be used to form e-mail addresses of new users |
| A | 421 | // Specify an array with 'host' => 'domain' values to support multiple hosts |
| bb8721 | 422 | // Supported replacement variables: |
| A | 423 | // %h - user's IMAP hostname |
| 424 | // %n - http hostname ($_SERVER['SERVER_NAME']) | |
| 425 | // %d - domain (http hostname without the first part) | |
| 11be93 | 426 | // %z - IMAP domain (IMAP hostname without the first part) |
| d359dc | 427 | // For example %n = mail.domain.tld, %t = domain.tld |
| acc005 | 428 | $config['mail_domain'] = ''; |
| 2d08c5 | 429 | |
| A | 430 | // Password charset. |
| 431 | // Use it if your authentication backend doesn't support UTF-8. | |
| 432 | // Defaults to ISO-8859-1 for backward compatibility | |
| acc005 | 433 | $config['password_charset'] = 'ISO-8859-1'; |
| 2d08c5 | 434 | |
| A | 435 | // How many seconds must pass between emails sent by a user |
| acc005 | 436 | $config['sendmail_delay'] = 0; |
| 2d08c5 | 437 | |
| 751b22 | 438 | // Maximum number of recipients per message. Default: 0 (no limit) |
| acc005 | 439 | $config['max_recipients'] = 0; |
| 751b22 | 440 | |
| d1851b | 441 | // Maximum allowednumber of members of an address group. Default: 0 (no limit) |
| T | 442 | // If 'max_recipients' is set this value should be less or equal |
| acc005 | 443 | $config['max_group_members'] = 0; |
| d1851b | 444 | |
| 9bacb2 | 445 | // Name your service. This is displayed on the login screen and in the window title |
| acc005 | 446 | $config['product_name'] = 'Roundcube Webmail'; |
| 2d08c5 | 447 | |
| 9bacb2 | 448 | // Add this user-agent to message headers when sending |
| TB | 449 | $config['useragent'] = 'Roundcube Webmail/'.RCMAIL_VERSION; |
| 2d08c5 | 450 | |
| A | 451 | // try to load host-specific configuration |
| 452 | // see http://trac.roundcube.net/wiki/Howto_Config for more details | |
| acc005 | 453 | $config['include_host_config'] = false; |
| 2d08c5 | 454 | |
| A | 455 | // path to a text file which will be added to each sent message |
| e019f2 | 456 | // paths are relative to the Roundcube root folder |
| acc005 | 457 | $config['generic_message_footer'] = ''; |
| 2d08c5 | 458 | |
| 5852c1 | 459 | // path to a text file which will be added to each sent HTML message |
| e019f2 | 460 | // paths are relative to the Roundcube root folder |
| acc005 | 461 | $config['generic_message_footer_html'] = ''; |
| 5852c1 | 462 | |
| 2d08c5 | 463 | // add a received header to outgoing mails containing the creators IP and hostname |
| acc005 | 464 | $config['http_received_header'] = false; |
| 2d08c5 | 465 | |
| A | 466 | // Whether or not to encrypt the IP address and the host name |
| 467 | // these could, in some circles, be considered as sensitive information; | |
| 468 | // however, for the administrator, these could be invaluable help | |
| 469 | // when tracking down issues. | |
| acc005 | 470 | $config['http_received_header_encrypt'] = false; |
| 2d08c5 | 471 | |
| ac8edb | 472 | // This string is used as a delimiter for message headers when sending |
| A | 473 | // a message via mail() function. Leave empty for auto-detection |
| acc005 | 474 | $config['mail_header_delimiter'] = NULL; |
| 2d08c5 | 475 | |
| 6b6f2e | 476 | // number of chars allowed for line when wrapping text. |
| T | 477 | // text wrapping is done when composing/sending messages |
| acc005 | 478 | $config['line_length'] = 72; |
| 6b6f2e | 479 | |
| T | 480 | // send plaintext messages as format=flowed |
| acc005 | 481 | $config['send_format_flowed'] = true; |
| 2d08c5 | 482 | |
| 232535 | 483 | // According to RFC2298, return receipt envelope sender address must be empty. |
| AM | 484 | // If this option is true, Roundcube will use user's identity as envelope sender for MDN responses. |
| acc005 | 485 | $config['mdn_use_from'] = false; |
| 232535 | 486 | |
| 2d08c5 | 487 | // Set identities access level: |
| A | 488 | // 0 - many identities with possibility to edit all params |
| 489 | // 1 - many identities with possibility to edit all params but not email address | |
| 490 | // 2 - one identity with possibility to edit all params | |
| 491 | // 3 - one identity with possibility to edit all params but not email address | |
| f12585 | 492 | // 4 - one identity with possibility to edit only signature |
| acc005 | 493 | $config['identities_level'] = 0; |
| 2d08c5 | 494 | |
| 3cc1af | 495 | // Maximum size of uploaded image in kilobytes |
| AM | 496 | // Images (in html signatures) are stored in database as data URIs |
| 497 | $config['identity_image_size'] = 64; | |
| 498 | ||
| f7b58a | 499 | // Mimetypes supported by the browser. |
| T | 500 | // attachments of these types will open in a preview window |
| 501 | // either a comma-separated list or an array: 'text/plain,text/html,text/xml,image/jpeg,image/gif,image/png,application/pdf' | |
| acc005 | 502 | $config['client_mimetypes'] = null; # null == default |
| f7b58a | 503 | |
| 0a8397 | 504 | // Path to a local mime magic database file for PHPs finfo extension. |
| TB | 505 | // Set to null if the default path should be used. |
| acc005 | 506 | $config['mime_magic'] = null; |
| 0a8397 | 507 | |
| 9e1605 | 508 | // Absolute path to a local mime.types mapping table file. |
| 0a8397 | 509 | // This is used to derive mime-types from the filename extension or vice versa. |
| 9e1605 | 510 | // Such a file is usually part of the apache webserver. If you don't find a file named mime.types on your system, |
| TB | 511 | // download it from http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types |
| acc005 | 512 | $config['mime_types'] = null; |
| 2d08c5 | 513 | |
| 2ea271 | 514 | // path to imagemagick identify binary (if not set we'll use Imagick or GD extensions) |
| acc005 | 515 | $config['im_identify_path'] = null; |
| 0501b6 | 516 | |
| 2ea271 | 517 | // path to imagemagick convert binary (if not set we'll use Imagick or GD extensions) |
| acc005 | 518 | $config['im_convert_path'] = null; |
| 0501b6 | 519 | |
| 031491 | 520 | // Size of thumbnails from image attachments displayed below the message content. |
| TB | 521 | // Note: whether images are displayed at all depends on the 'inline_images' option. |
| 522 | // Set to 0 to display images in full size. | |
| acc005 | 523 | $config['image_thumbnail_size'] = 240; |
| 031491 | 524 | |
| 0501b6 | 525 | // maximum size of uploaded contact photos in pixel |
| acc005 | 526 | $config['contact_photo_size'] = 160; |
| 0501b6 | 527 | |
| 2d08c5 | 528 | // Enable DNS checking for e-mail address validation |
| acc005 | 529 | $config['email_dns_check'] = false; |
| 2d08c5 | 530 | |
| e04e31 | 531 | // Disables saving sent messages in Sent folder (like gmail) (Default: false) |
| AM | 532 | // Note: useful when SMTP server stores sent mail in user mailbox |
| acc005 | 533 | $config['no_save_sent_messages'] = false; |
| e04e31 | 534 | |
| 2d08c5 | 535 | // ---------------------------------- |
| A | 536 | // PLUGINS |
| 537 | // ---------------------------------- | |
| 538 | ||
| 539 | // List of active plugins (in plugins/ directory) | |
| acc005 | 540 | $config['plugins'] = array(); |
| 2d08c5 | 541 | |
| A | 542 | // ---------------------------------- |
| 543 | // USER INTERFACE | |
| 544 | // ---------------------------------- | |
| 545 | ||
| f52c93 | 546 | // default messages sort column. Use empty value for default server's sorting, |
| e0efd8 | 547 | // or 'arrival', 'date', 'subject', 'from', 'to', 'fromto', 'size', 'cc' |
| acc005 | 548 | $config['message_sort_col'] = ''; |
| 2d08c5 | 549 | |
| f52c93 | 550 | // default messages sort order |
| acc005 | 551 | $config['message_sort_order'] = 'DESC'; |
| 2d08c5 | 552 | |
| A | 553 | // These cols are shown in the message list. Available cols are: |
| e0efd8 | 554 | // subject, from, to, fromto, cc, replyto, date, size, status, flag, attachment, 'priority' |
| acc005 | 555 | $config['list_cols'] = array('subject', 'status', 'fromto', 'date', 'size', 'flag', 'attachment'); |
| 2d08c5 | 556 | |
| c8ae24 | 557 | // the default locale setting (leave empty for auto-detection) |
| T | 558 | // RFC1766 formatted language name like en_US, de_DE, de_CH, fr_FR, pt_BR |
| acc005 | 559 | $config['language'] = null; |
| 4e17e6 | 560 | |
| 1cc9e2 | 561 | // use this format for date display (date or strftime format) |
| acc005 | 562 | $config['date_format'] = 'Y-m-d'; |
| 1cc9e2 | 563 | |
| T | 564 | // give this choice of date formats to the user to select from |
| b32fab | 565 | // Note: do not use ambiguous formats like m/d/Y |
| AM | 566 | $config['date_formats'] = array('Y-m-d', 'Y/m/d', 'Y.m.d', 'd-m-Y', 'd/m/Y', 'd.m.Y', 'j.n.Y'); |
| 1cc9e2 | 567 | |
| T | 568 | // use this format for time display (date or strftime format) |
| acc005 | 569 | $config['time_format'] = 'H:i'; |
| 1cc9e2 | 570 | |
| T | 571 | // give this choice of time formats to the user to select from |
| acc005 | 572 | $config['time_formats'] = array('G:i', 'H:i', 'g:i a', 'h:i A'); |
| 1cc9e2 | 573 | |
| T | 574 | // use this format for short date display (derived from date_format and time_format) |
| acc005 | 575 | $config['date_short'] = 'D H:i'; |
| 4e17e6 | 576 | |
| 1cc9e2 | 577 | // use this format for detailed date/time formatting (derived from date_format and time_format) |
| acc005 | 578 | $config['date_long'] = 'Y-m-d H:i'; |
| 4e17e6 | 579 | |
| 1966c5 | 580 | // store draft message is this mailbox |
| S | 581 | // leave blank if draft messages should not be stored |
| d08333 | 582 | // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP) |
| acc005 | 583 | $config['drafts_mbox'] = 'Drafts'; |
| 1966c5 | 584 | |
| b4b081 | 585 | // store spam messages in this mailbox |
| d08333 | 586 | // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP) |
| acc005 | 587 | $config['junk_mbox'] = 'Junk'; |
| b4b081 | 588 | |
| 4e17e6 | 589 | // store sent message is this mailbox |
| T | 590 | // leave blank if sent messages should not be stored |
| d08333 | 591 | // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP) |
| acc005 | 592 | $config['sent_mbox'] = 'Sent'; |
| 4e17e6 | 593 | |
| T | 594 | // move messages to this folder when deleting them |
| 595 | // leave blank if they should be deleted directly | |
| d08333 | 596 | // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP) |
| acc005 | 597 | $config['trash_mbox'] = 'Trash'; |
| 4e17e6 | 598 | |
| 95ebcd | 599 | // automatically create the above listed default folders on first login |
| acc005 | 600 | $config['create_default_folders'] = false; |
| b2ff3d | 601 | |
| c8c1e0 | 602 | // protect the default folders from renames, deletes, and subscription changes |
| acc005 | 603 | $config['protect_default_folders'] = true; |
| c8c1e0 | 604 | |
| dc0b50 | 605 | // Disable localization of the default folder names listed above |
| AM | 606 | $config['show_real_foldernames'] = false; |
| 607 | ||
| 2d08c5 | 608 | // if in your system 0 quota means no limit set this option to true |
| acc005 | 609 | $config['quota_zero_as_unlimited'] = false; |
| 876b15 | 610 | |
| 996066 | 611 | // Make use of the built-in spell checker. It is based on GoogieSpell. |
| e9ac14 | 612 | // Since Google only accepts connections over https your PHP installatation |
| T | 613 | // requires to be compiled with Open SSL support |
| acc005 | 614 | $config['enable_spellcheck'] = true; |
| ed5d29 | 615 | |
| 66df08 | 616 | // Enables spellchecker exceptions dictionary. |
| A | 617 | // Setting it to 'shared' will make the dictionary shared by all users. |
| acc005 | 618 | $config['spellcheck_dictionary'] = false; |
| 66df08 | 619 | |
| b52166 | 620 | // Set the spell checking engine. Possible values: |
| TB | 621 | // - 'googie' - the default |
| 622 | // - 'pspell' - requires the PHP Pspell module and aspell installed | |
| 623 | // - 'enchant' - requires the PHP Enchant module | |
| 624 | // - 'atd' - install your own After the Deadline server or check with the people at http://www.afterthedeadline.com before using their API | |
| 625 | // Since Google shut down their public spell checking service, you need to | |
| 626 | // connect to a Nox Spell Server when using 'googie' here. Therefore specify the 'spellcheck_uri' | |
| acc005 | 627 | $config['spellcheck_engine'] = 'googie'; |
| 5d2b7f | 628 | |
| b52166 | 629 | // For locally installed Nox Spell Server or After the Deadline services, |
| TB | 630 | // please specify the URI to call it. |
| 631 | // Get Nox Spell Server from http://orangoo.com/labs/?page_id=72 or | |
| 632 | // the After the Deadline package from http://www.afterthedeadline.com. | |
| 633 | // Leave empty to use the public API of service.afterthedeadline.com | |
| acc005 | 634 | $config['spellcheck_uri'] = ''; |
| 996066 | 635 | |
| T | 636 | // These languages can be selected for spell checking. |
| 637 | // Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch'); | |
| 01a8c5 | 638 | // Leave empty for default set of available language. |
| acc005 | 639 | $config['spellcheck_languages'] = NULL; |
| 996066 | 640 | |
| 66df08 | 641 | // Makes that words with all letters capitalized will be ignored (e.g. GOOGLE) |
| acc005 | 642 | $config['spellcheck_ignore_caps'] = false; |
| 66df08 | 643 | |
| A | 644 | // Makes that words with numbers will be ignored (e.g. g00gle) |
| acc005 | 645 | $config['spellcheck_ignore_nums'] = false; |
| 66df08 | 646 | |
| A | 647 | // Makes that words with symbols will be ignored (e.g. g@@gle) |
| acc005 | 648 | $config['spellcheck_ignore_syms'] = false; |
| 66df08 | 649 | |
| 62c861 | 650 | // Use this char/string to separate recipients when composing a new message |
| acc005 | 651 | $config['recipients_separator'] = ','; |
| 62c861 | 652 | |
| 2d08c5 | 653 | // don't let users set pagesize to more than this value if set |
| acc005 | 654 | $config['max_pagesize'] = 200; |
| 967b34 | 655 | |
| f22654 | 656 | // Minimal value of user's 'refresh_interval' setting (in seconds) |
| acc005 | 657 | $config['min_refresh_interval'] = 60; |
| 2471d3 | 658 | |
| 4171c5 | 659 | // Enables files upload indicator. Requires APC installed and enabled apc.rfc1867 option. |
| A | 660 | // By default refresh time is set to 1 second. You can set this value to true |
| 661 | // or any integer value indicating number of seconds. | |
| acc005 | 662 | $config['upload_progress'] = false; |
| 4171c5 | 663 | |
| 63fda8 | 664 | // Specifies for how many seconds the Undo button will be available |
| A | 665 | // after object delete action. Currently used with supporting address book sources. |
| 666 | // Setting it to 0, disables the feature. | |
| acc005 | 667 | $config['undo_timeout'] = 0; |
| 63fda8 | 668 | |
| 9c41ba | 669 | // A static list of canned responses which are immutable for the user |
| TB | 670 | $config['compose_responses_static'] = array( |
| 671 | // array('name' => 'Canned Response 1', 'text' => 'Static Response One'), | |
| 672 | // array('name' => 'Canned Response 2', 'text' => 'Static Response Two'), | |
| 673 | ); | |
| 674 | ||
| 2d08c5 | 675 | // ---------------------------------- |
| A | 676 | // ADDRESSBOOK SETTINGS |
| 677 | // ---------------------------------- | |
| aec82b | 678 | |
| 6153e2 | 679 | // This indicates which type of address book to use. Possible choises: |
| 5526f9 | 680 | // 'sql' (default), 'ldap' and ''. |
| 6153e2 | 681 | // If set to 'ldap' then it will look at using the first writable LDAP |
| 4f9c83 | 682 | // address book as the primary address book and it will not display the |
| S | 683 | // SQL address book in the 'Address Book' view. |
| 5526f9 | 684 | // If set to '' then no address book will be displayed or only the |
| JD | 685 | // addressbook which is created by a plugin (like CardDAV). |
| acc005 | 686 | $config['address_book_type'] = 'sql'; |
| 4f9c83 | 687 | |
| S | 688 | // In order to enable public ldap search, configure an array like the Verisign |
| 689 | // example further below. if you would like to test, simply uncomment the example. | |
| ecf295 | 690 | // Array key must contain only safe characters, ie. a-zA-Z0-9_ |
| acc005 | 691 | $config['ldap_public'] = array(); |
| 5f25a1 | 692 | |
| 4f9c83 | 693 | // If you are going to use LDAP for individual address books, you will need to |
| S | 694 | // set 'user_specific' to true and use the variables to generate the appropriate DNs to access it. |
| 695 | // | |
| 696 | // The recommended directory structure for LDAP is to store all the address book entries | |
| 697 | // under the users main entry, e.g.: | |
| 698 | // | |
| 699 | // o=root | |
| 700 | // ou=people | |
| 701 | // uid=user@domain | |
| 3b9a53 | 702 | // mail=contact@contactdomain |
| T | 703 | // |
| 4f9c83 | 704 | // So the base_dn would be uid=%fu,ou=people,o=root |
| S | 705 | // The bind_dn would be the same as based_dn or some super user login. |
| 3b9a53 | 706 | /* |
| f11541 | 707 | * example config for Verisign directory |
| eea43f | 708 | * |
| acc005 | 709 | $config['ldap_public']['Verisign'] = array( |
| 3b9a53 | 710 | 'name' => 'Verisign.com', |
| bb8721 | 711 | // Replacement variables supported in host names: |
| A | 712 | // %h - user's IMAP hostname |
| d359dc | 713 | // %n - hostname ($_SERVER['SERVER_NAME']) |
| B | 714 | // %t - hostname without the first part |
| 715 | // %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part) | |
| 11be93 | 716 | // %z - IMAP domain (IMAP hostname without the first part) |
| d359dc | 717 | // For example %n = mail.domain.tld, %t = domain.tld |
| 3b9a53 | 718 | 'hosts' => array('directory.verisign.com'), |
| T | 719 | 'port' => 389, |
| c64bee | 720 | 'use_tls' => false, |
| 0c5210 | 721 | 'ldap_version' => 3, // using LDAPv3 |
| e114a6 | 722 | 'network_timeout' => 10, // The timeout (in seconds) for connect + bind arrempts. This is only supported in PHP >= 5.3.0 with OpenLDAP 2.x |
| 3b9a53 | 723 | 'user_specific' => false, // If true the base_dn, bind_dn and bind_pass default to the user's IMAP login. |
| 221b40 | 724 | // When 'user_specific' is enabled following variables can be used in base_dn/bind_dn config: |
| 3b9a53 | 725 | // %fu - The full username provided, assumes the username is an email |
| T | 726 | // address, uses the username_domain value if not an email address. |
| 727 | // %u - The username prior to the '@'. | |
| 728 | // %d - The domain name after the '@'. | |
| f76765 | 729 | // %dc - The domain name hierarchal string e.g. "dc=test,dc=domain,dc=com" |
| 1148c6 | 730 | // %dn - DN found by ldap search when search_filter/search_base_dn are used |
| 3b9a53 | 731 | 'base_dn' => '', |
| T | 732 | 'bind_dn' => '', |
| 733 | 'bind_pass' => '', | |
| 1148c6 | 734 | // It's possible to bind for an individual address book |
| A | 735 | // The login name is used to search for the DN to bind with |
| 736 | 'search_base_dn' => '', | |
| 737 | 'search_filter' => '', // e.g. '(&(objectClass=posixAccount)(uid=%u))' | |
| 2d08ec | 738 | // DN and password to bind as before searching for bind DN, if anonymous search is not allowed |
| A | 739 | 'search_bind_dn' => '', |
| 740 | 'search_bind_pw' => '', | |
| 3ce7c5 | 741 | // Optional map of replacement strings => attributes used when binding for an individual address book |
| TB | 742 | 'search_bind_attrib' => array(), // e.g. array('%udc' => 'ou') |
| c041d5 | 743 | // Default for %dn variable if search doesn't return DN value |
| A | 744 | 'search_dn_default' => '', |
| 4d982d | 745 | // Optional authentication identifier to be used as SASL authorization proxy |
| A | 746 | // bind_dn need to be empty |
| 747 | 'auth_cid' => '', | |
| 748 | // SASL authentication method (for proxy auth), e.g. DIGEST-MD5 | |
| 749 | 'auth_method' => '', | |
| 2d3e2b | 750 | // Indicates if the addressbook shall be hidden from the list. |
| 5c9d1f | 751 | // With this option enabled you can still search/view contacts. |
| A | 752 | 'hidden' => false, |
| 2d3e2b | 753 | // Indicates if the addressbook shall not list contacts but only allows searching. |
| T | 754 | 'searchonly' => false, |
| 0c5210 | 755 | // Indicates if we can write to the LDAP directory or not. |
| 3b9a53 | 756 | // If writable is true then these fields need to be populated: |
| T | 757 | // LDAP_Object_Classes, required_fields, LDAP_rdn |
| 0c5210 | 758 | 'writable' => false, |
| A | 759 | // To create a new contact these are the object classes to specify |
| 760 | // (or any other classes you wish to use). | |
| 761 | 'LDAP_Object_Classes' => array('top', 'inetOrgPerson'), | |
| 762 | // The RDN field that is used for new entries, this field needs | |
| 763 | // to be one of the search_fields, the base of base_dn is appended | |
| 764 | // to the RDN to insert into the LDAP directory. | |
| ca3d76 | 765 | 'LDAP_rdn' => 'cn', |
| 0c5210 | 766 | // The required fields needed to build a new contact as required by |
| A | 767 | // the object classes (can include additional fields not required by the object classes). |
| 768 | 'required_fields' => array('cn', 'sn', 'mail'), | |
| 769 | 'search_fields' => array('mail', 'cn'), // fields to search in | |
| 770 | // mapping of contact fields to directory attributes | |
| a605b2 | 771 | // for every attribute one can specify the number of values (limit) allowed. |
| T | 772 | // default is 1, a wildcard * means unlimited |
| 0c5210 | 773 | 'fieldmap' => array( |
| a605b2 | 774 | // Roundcube => LDAP:limit |
| 0501b6 | 775 | 'name' => 'cn', |
| T | 776 | 'surname' => 'sn', |
| 777 | 'firstname' => 'givenName', | |
| b2c3c3 | 778 | 'jobtitle' => 'title', |
| a605b2 | 779 | 'email' => 'mail:*', |
| 0501b6 | 780 | 'phone:home' => 'homePhone', |
| T | 781 | 'phone:work' => 'telephoneNumber', |
| 782 | 'phone:mobile' => 'mobile', | |
| ca3d76 | 783 | 'phone:pager' => 'pager', |
| e43cc4 | 784 | 'phone:workfax' => 'facsimileTelephoneNumber', |
| 0501b6 | 785 | 'street' => 'street', |
| T | 786 | 'zipcode' => 'postalCode', |
| ca3d76 | 787 | 'region' => 'st', |
| 0501b6 | 788 | 'locality' => 'l', |
| a605b2 | 789 | // if you country is a complex object, you need to configure 'sub_fields' below |
| T | 790 | 'country' => 'c', |
| b563fc | 791 | 'organization' => 'o', |
| a605b2 | 792 | 'department' => 'ou', |
| T | 793 | 'jobtitle' => 'title', |
| 794 | 'notes' => 'description', | |
| e43cc4 | 795 | 'photo' => 'jpegPhoto', |
| a605b2 | 796 | // these currently don't work: |
| T | 797 | // 'manager' => 'manager', |
| 798 | // 'assistant' => 'secretary', | |
| 0501b6 | 799 | ), |
| a605b2 | 800 | // Map of contact sub-objects (attribute name => objectClass(es)), e.g. 'c' => 'country' |
| T | 801 | 'sub_fields' => array(), |
| 3f250a | 802 | // Generate values for the following LDAP attributes automatically when creating a new record |
| TB | 803 | 'autovalues' => array( |
| 804 | // 'uid' => 'md5(microtime())', // You may specify PHP code snippets which are then eval'ed | |
| 805 | // 'mail' => '{givenname}.{sn}@mydomain.com', // or composite strings with placeholders for existing attributes | |
| 806 | ), | |
| a6d418 | 807 | 'sort' => 'cn', // The field to sort the listing by. |
| TB | 808 | 'scope' => 'sub', // search mode: sub|base|list |
| 809 | 'filter' => '(objectClass=inetOrgPerson)', // used for basic listing (if not empty) and will be &'d with search queries. example: status=act | |
| 810 | 'fuzzy_search' => true, // server allows wildcard search | |
| 811 | 'vlv' => false, // Enable Virtual List View to more efficiently fetch paginated data (if server supports it) | |
| 812 | 'vlv_search' => false, // Use Virtual List View functions for autocompletion searches (if server supports it) | |
| 813 | '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 | |
| 814 | 'config_root_dn' => 'cn=config', // Root DN to search config entries (e.g. vlv indexes) | |
| 815 | 'sizelimit' => '0', // Enables you to limit the count of entries fetched. Setting this to 0 means no limit. | |
| 816 | 'timelimit' => '0', // Sets the number of seconds how long is spend on the search. Setting this to 0 means no limit. | |
| 817 | 'referrals' => false, // Sets the LDAP_OPT_REFERRALS option. Mostly used in multi-domain Active Directory setups | |
| d51900 | 818 | 'dereference' => 0, // Sets the LDAP_OPT_DEREF option. One of: LDAP_DEREF_NEVER, LDAP_DEREF_SEARCHING, LDAP_DEREF_FINDING, LDAP_DEREF_ALWAYS |
| AM | 819 | // Used where addressbook contains aliases to objects elsewhere in the LDAP tree. |
| d1e08f | 820 | |
| T | 821 | // definition for contact groups (uncomment if no groups are supported) |
| 822 | // for the groups base_dn, the user replacements %fu, %u, $d and %dc work as for base_dn (see above) | |
| 823 | // if the groups base_dn is empty, the contact base_dn is used for the groups as well | |
| 15d762 | 824 | // -> in this case, assure that groups and contacts are separated due to the concernig filters! |
| a6d418 | 825 | 'groups' => array( |
| 3ce7c5 | 826 | 'base_dn' => '', |
| TB | 827 | 'scope' => 'sub', // Search mode: sub|base|list |
| 828 | 'filter' => '(objectClass=groupOfNames)', | |
| 829 | 'object_classes' => array('top', 'groupOfNames'), // Object classes to be assigned to new groups | |
| 830 | 'member_attr' => 'member', // Name of the default member attribute, e.g. uniqueMember | |
| 831 | 'name_attr' => 'cn', // Attribute to be used as group name | |
| 832 | 'email_attr' => 'mail', // Group email address attribute (e.g. for mailing lists) | |
| 833 | 'member_filter' => '(objectclass=*)', // Optional filter to use when querying for group members | |
| 834 | 'vlv' => false, // Use VLV controls to list groups | |
| 835 | 'class_member_attr' => array( // Mapping of group object class to member attribute used in these objects | |
| 836 | 'groupofnames' => 'member', | |
| 837 | 'groupofuniquenames' => 'uniquemember' | |
| 838 | ), | |
| 6039aa | 839 | ), |
| e43cc4 | 840 | // this configuration replaces the regular groups listing in the directory tree with |
| TB | 841 | // a hard-coded list of groups, each listing entries with the configured base DN and filter. |
| 842 | // if the 'groups' option from above is set, it'll be shown as the first entry with the name 'Groups' | |
| 843 | 'group_filters' => array( | |
| 844 | 'departments' => array( | |
| 845 | 'name' => 'Company Departments', | |
| 846 | 'scope' => 'list', | |
| 847 | 'base_dn' => 'ou=Groups,dc=mydomain,dc=com', | |
| 848 | 'filter' => '(|(objectclass=groupofuniquenames)(objectclass=groupofurls))', | |
| 9eaf68 | 849 | 'name_attr' => 'cn', |
| e43cc4 | 850 | ), |
| TB | 851 | 'customers' => array( |
| 852 | 'name' => 'Customers', | |
| 853 | 'scope' => 'sub', | |
| 854 | 'base_dn' => 'ou=Customers,dc=mydomain,dc=com', | |
| 855 | 'filter' => '(objectClass=inetOrgPerson)', | |
| 9eaf68 | 856 | 'name_attr' => 'sn', |
| e43cc4 | 857 | ), |
| 2c8e84 | 858 | ), |
| T | 859 | ); |
| 860 | */ | |
| c296b8 | 861 | |
| A | 862 | // An ordered array of the ids of the addressbooks that should be searched |
| 863 | // when populating address autocomplete fields server-side. ex: array('sql','Verisign'); | |
| acc005 | 864 | $config['autocomplete_addressbooks'] = array('sql'); |
| b19097 | 865 | |
| c296b8 | 866 | // The minimum number of characters required to be typed in an autocomplete field |
| A | 867 | // before address books will be searched. Most useful for LDAP directories that |
| 868 | // may need to do lengthy results building given overly-broad searches | |
| acc005 | 869 | $config['autocomplete_min_length'] = 1; |
| c296b8 | 870 | |
| 0213f8 | 871 | // Number of parallel autocomplete requests. |
| A | 872 | // If there's more than one address book, n parallel (async) requests will be created, |
| 873 | // where each request will search in one address book. By default (0), all address | |
| 874 | // books are searched in one request. | |
| acc005 | 875 | $config['autocomplete_threads'] = 0; |
| 0213f8 | 876 | |
| A | 877 | // Max. numer of entries in autocomplete popup. Default: 15. |
| acc005 | 878 | $config['autocomplete_max'] = 15; |
| 0213f8 | 879 | |
| 0501b6 | 880 | // show address fields in this order |
| T | 881 | // available placeholders: {street}, {locality}, {zipcode}, {country}, {region} |
| acc005 | 882 | $config['address_template'] = '{street}<br/>{locality} {zipcode}<br/>{country} {region}'; |
| 0501b6 | 883 | |
| f21a04 | 884 | // Matching mode for addressbook search (including autocompletion) |
| A | 885 | // 0 - partial (*abc*), default |
| 886 | // 1 - strict (abc) | |
| 887 | // 2 - prefix (abc*) | |
| 888 | // Note: For LDAP sources fuzzy_search must be enabled to use 'partial' or 'prefix' mode | |
| acc005 | 889 | $config['addressbook_search_mode'] = 0; |
| f21a04 | 890 | |
| 36d004 | 891 | // Template of contact entry on the autocompletion list. |
| AM | 892 | // You can use contact fields as: name, email, organization, department, etc. |
| 893 | // See program/steps/addressbook/func.inc for a list | |
| 894 | $config['contact_search_name'] = '{name} <{email}>'; | |
| 895 | ||
| 2d08c5 | 896 | // ---------------------------------- |
| A | 897 | // USER PREFERENCES |
| 898 | // ---------------------------------- | |
| 4e17e6 | 899 | |
| e55ab0 | 900 | // Use this charset as fallback for message decoding |
| acc005 | 901 | $config['default_charset'] = 'ISO-8859-1'; |
| e55ab0 | 902 | |
| 67effe | 903 | // skin name: folder from skins/ |
| acc005 | 904 | $config['skin'] = 'larry'; |
| e58df3 | 905 | |
| 3863a9 | 906 | // Enables using standard browser windows (that can be handled as tabs) |
| AM | 907 | // instead of popup windows |
| acc005 | 908 | $config['standard_windows'] = false; |
| 3863a9 | 909 | |
| 08ffd9 | 910 | // show up to X items in messages list view |
| acc005 | 911 | $config['mail_pagesize'] = 50; |
| 08ffd9 | 912 | |
| A | 913 | // show up to X items in contacts list view |
| acc005 | 914 | $config['addressbook_pagesize'] = 50; |
| 4e17e6 | 915 | |
| 438753 | 916 | // sort contacts by this col (preferably either one of name, firstname, surname) |
| acc005 | 917 | $config['addressbook_sort_col'] = 'surname'; |
| 438753 | 918 | |
| f9a967 | 919 | // the way how contact names are displayed in the list |
| T | 920 | // 0: display name |
| 921 | // 1: (prefix) firstname middlename surname (suffix) | |
| 922 | // 2: (prefix) surname firstname middlename (suffix) | |
| 923 | // 3: (prefix) surname, firstname middlename (suffix) | |
| acc005 | 924 | $config['addressbook_name_listing'] = 0; |
| f9a967 | 925 | |
| 4e17e6 | 926 | // use this timezone to display date/time |
| 5879c0 | 927 | // valid timezone identifers are listed here: php.net/manual/en/timezones.php |
| T | 928 | // 'auto' will use the browser's timezone settings |
| acc005 | 929 | $config['timezone'] = 'auto'; |
| 4647e1 | 930 | |
| 4e17e6 | 931 | // prefer displaying HTML messages |
| acc005 | 932 | $config['prefer_html'] = true; |
| 4e17e6 | 933 | |
| 2a4135 | 934 | // display remote inline images |
| A | 935 | // 0 - Never, always ask |
| 936 | // 1 - Ask if sender is not in address book | |
| 937 | // 2 - Always show inline images | |
| acc005 | 938 | $config['show_images'] = 0; |
| 712b30 | 939 | |
| 271efe | 940 | // open messages in new window |
| acc005 | 941 | $config['message_extwin'] = false; |
| 271efe | 942 | |
| TB | 943 | // open message compose form in new window |
| acc005 | 944 | $config['compose_extwin'] = false; |
| 271efe | 945 | |
| b19097 | 946 | // compose html formatted messages by default |
| 8eefbb | 947 | // 0 - never, 1 - always, 2 - on reply to HTML message, 3 - on forward or reply to HTML message |
| acc005 | 948 | $config['htmleditor'] = 0; |
| b19097 | 949 | |
| 44b47d | 950 | // save copies of compose messages in the browser's local storage |
| TB | 951 | // for recovery in case of browser crashes and session timeout. |
| 952 | $config['compose_save_localstorage'] = true; | |
| 953 | ||
| 30233b | 954 | // show pretty dates as standard |
| acc005 | 955 | $config['prettydate'] = true; |
| 4e17e6 | 956 | |
| d656f1 | 957 | // save compose message every 300 seconds (5min) |
| acc005 | 958 | $config['draft_autosave'] = 300; |
| 0566ad | 959 | |
| b19097 | 960 | // default setting if preview pane is enabled |
| acc005 | 961 | $config['preview_pane'] = false; |
| b19097 | 962 | |
| bc4960 | 963 | // Mark as read when viewed in preview pane (delay in seconds) |
| T | 964 | // Set to -1 if messages in preview pane should not be marked as read |
| acc005 | 965 | $config['preview_pane_mark_read'] = 0; |
| bc4960 | 966 | |
| eaa394 | 967 | // Clear Trash on logout |
| acc005 | 968 | $config['logout_purge'] = false; |
| eaa394 | 969 | |
| A | 970 | // Compact INBOX on logout |
| acc005 | 971 | $config['logout_expunge'] = false; |
| 50c753 | 972 | |
| 166b61 | 973 | // Display attached images below the message body |
| acc005 | 974 | $config['inline_images'] = true; |
| 5e0045 | 975 | |
| ffae15 | 976 | // Encoding of long/non-ascii attachment names: |
| A | 977 | // 0 - Full RFC 2231 compatible |
| 978 | // 1 - RFC 2047 for 'name' and RFC 2231 for 'filename' parameter (Thunderbird's default) | |
| 979 | // 2 - Full 2047 compatible | |
| acc005 | 980 | $config['mime_param_folding'] = 1; |
| ffae15 | 981 | |
| 2d08c5 | 982 | // Set true if deleted messages should not be displayed |
| 2b5852 | 983 | // This will make the application run slower |
| acc005 | 984 | $config['skip_deleted'] = false; |
| 2b5852 | 985 | |
| A | 986 | // Set true to Mark deleted messages as read as well as deleted |
| 987 | // False means that a message's read status is not affected by marking it as deleted | |
| acc005 | 988 | $config['read_when_deleted'] = true; |
| 2b5852 | 989 | |
| ca8a17 | 990 | // Set to true to never delete messages immediately |
| A | 991 | // Use 'Purge' to remove messages marked as deleted |
| acc005 | 992 | $config['flag_for_deletion'] = false; |
| 2b5852 | 993 | |
| aa8359 | 994 | // Default interval for auto-refresh requests (in seconds) |
| AM | 995 | // These are requests for system state updates e.g. checking for new messages, etc. |
| 996 | // Setting it to 0 disables the feature. | |
| acc005 | 997 | $config['refresh_interval'] = 60; |
| 95d90f | 998 | |
| 2fd975 | 999 | // If true all folders will be checked for recent messages |
| acc005 | 1000 | $config['check_all_folders'] = false; |
| 2fd975 | 1001 | |
| e54bb7 | 1002 | // If true, after message delete/move, the next message will be displayed |
| acc005 | 1003 | $config['display_next'] = true; |
| e54bb7 | 1004 | |
| cd01dc | 1005 | // Default messages listing mode. One of 'threads' or 'list'. |
| AM | 1006 | $config['default_list_mode'] = 'list'; |
| 1007 | ||
| 1008 | // 0 - Do not expand threads | |
| 1009 | // 1 - Expand all threads automatically | |
| 1010 | // 2 - Expand only threads with unread messages | |
| acc005 | 1011 | $config['autoexpand_threads'] = 0; |
| 1cead0 | 1012 | |
| 651c7b | 1013 | // When replying: |
| AM | 1014 | // -1 - don't cite the original message |
| 1015 | // 0 - place cursor below the original message | |
| 1016 | // 1 - place cursor above original message (top posting) | |
| acc005 | 1017 | $config['reply_mode'] = 0; |
| 50f56d | 1018 | |
| 0207c4 | 1019 | // When replying strip original signature from message |
| acc005 | 1020 | $config['strip_existing_sig'] = true; |
| 0207c4 | 1021 | |
| 50f56d | 1022 | // Show signature: |
| 0207c4 | 1023 | // 0 - Never |
| T | 1024 | // 1 - Always |
| 50f56d | 1025 | // 2 - New messages only |
| 0207c4 | 1026 | // 3 - Forwards and Replies only |
| acc005 | 1027 | $config['show_sig'] = 1; |
| 0207c4 | 1028 | |
| 47ad83 | 1029 | // Use MIME encoding (quoted-printable) for 8bit characters in message body |
| acc005 | 1030 | $config['force_7bit'] = false; |
| 47ad83 | 1031 | |
| b975da | 1032 | // Defaults of the search field configuration. |
| T | 1033 | // The array can contain a per-folder list of header fields which should be considered when searching |
| 1034 | // The entry with key '*' stands for all folders which do not have a specific list set. | |
| aecdf0 | 1035 | // Please note that folder names should to be in sync with $config['*_mbox'] options |
| acc005 | 1036 | $config['search_mods'] = null; // Example: array('*' => array('subject'=>1, 'from'=>1), 'Sent' => array('subject'=>1, 'to'=>1)); |
| b975da | 1037 | |
| 3cacf9 | 1038 | // Defaults of the addressbook search field configuration. |
| acc005 | 1039 | $config['addressbook_search_mods'] = null; // Example: array('name'=>1, 'firstname'=>1, 'surname'=>1, 'email'=>1, '*'=>1); |
| 3cacf9 | 1040 | |
| b7f952 | 1041 | // 'Delete always' |
| A | 1042 | // This setting reflects if mail should be always deleted |
| 1043 | // when moving to Trash fails. This is necessary in some setups | |
| 1044 | // when user is over quota and Trash is included in the quota. | |
| acc005 | 1045 | $config['delete_always'] = false; |
| b7f952 | 1046 | |
| 1b30a7 | 1047 | // Directly delete messages in Junk instead of moving to Trash |
| acc005 | 1048 | $config['delete_junk'] = false; |
| 1b30a7 | 1049 | |
| f22ea7 | 1050 | // Behavior if a received message requests a message delivery notification (read receipt) |
| A | 1051 | // 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask) |
| 1052 | // 3 = send automatically if sender is in addressbook, otherwise ask the user | |
| 1053 | // 4 = send automatically if sender is in addressbook, otherwise ignore | |
| acc005 | 1054 | $config['mdn_requests'] = 0; |
| b25dfd | 1055 | |
| f22ea7 | 1056 | // Return receipt checkbox default state |
| acc005 | 1057 | $config['mdn_default'] = 0; |
| f22ea7 | 1058 | |
| A | 1059 | // Delivery Status Notification checkbox default state |
| f1fba2 | 1060 | // Note: This can be used only if smtp_server is non-empty |
| acc005 | 1061 | $config['dsn_default'] = 0; |
| f22ea7 | 1062 | |
| eeb85f | 1063 | // Place replies in the folder of the message being replied to |
| acc005 | 1064 | $config['reply_same_folder'] = false; |
| eeb85f | 1065 | |
| a509bb | 1066 | // Sets default mode of Forward feature to "forward as attachment" |
| acc005 | 1067 | $config['forward_attachment'] = false; |
| a509bb | 1068 | |
| d73448 | 1069 | // Defines address book (internal index) to which new contacts will be added |
| A | 1070 | // By default it is the first writeable addressbook. |
| 1071 | // Note: Use '0' for built-in address book. | |
| acc005 | 1072 | $config['default_addressbook'] = null; |
| d73448 | 1073 | |
| 1d5779 | 1074 | // Enables spell checking before sending a message. |
| acc005 | 1075 | $config['spellcheck_before_send'] = false; |
| 1d5779 | 1076 | |
| 710b1b | 1077 | // Skip alternative email addresses in autocompletion (show one address per contact) |
| acc005 | 1078 | $config['autocomplete_single'] = false; |
| 710b1b | 1079 | |
| 7e263e | 1080 | // Default font for composed HTML message. |
| A | 1081 | // Supported values: Andale Mono, Arial, Arial Black, Book Antiqua, Courier New, |
| 1082 | // Georgia, Helvetica, Impact, Tahoma, Terminal, Times New Roman, Trebuchet MS, Verdana | |
| acc005 | 1083 | $config['default_font'] = 'Verdana'; |
| 7e263e | 1084 | |
| 7dff44 | 1085 | // Default font size for composed HTML message. |
| D | 1086 | // Supported sizes: 8pt, 10pt, 12pt, 14pt, 18pt, 24pt, 36pt |
| 189958 | 1087 | $config['default_font_size'] = '10pt'; |
| 7dff44 | 1088 | |
| 969cb0 | 1089 | // Enables display of email address with name instead of a name (and address in title) |
| acc005 | 1090 | $config['message_show_email'] = false; |
| b972b4 | 1091 | |
| AM | 1092 | // Default behavior of Reply-All button: |
| 1093 | // 0 - Reply-All always | |
| 1094 | // 1 - Reply-List if mailing list is detected | |
| 1095 | $config['reply_all_mode'] = 0; | |
