X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=config%2Fmain.inc.php.dist;h=efa45957cb9c27ea8c163a4fe7e0d4a4b0bc83c1;hb=5d60014828731869a502ce702478fd81f39c720b;hp=2f79bd8e8f977037e19bc3c799aa7f34521de7b1;hpb=0af63e79917234f76cfa7ec74e9d97b24fbf9b55;p=roundcube.git diff --git a/config/main.inc.php.dist b/config/main.inc.php.dist index 2f79bd8..efa4595 100644 --- a/config/main.inc.php.dist +++ b/config/main.inc.php.dist @@ -5,7 +5,7 @@ | Main configuration file | | | | This file is part of the RoundCube Webmail client | - | Copyright (C) 2005, RoundCube Dev. - Switzerland | + | Copyright (C) 2005-2009, RoundCube Dev. - Switzerland | | Licensed under the GNU GPL | | | +-----------------------------------------------------------------------+ @@ -14,18 +14,46 @@ $rcmail_config = array(); - // system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace $rcmail_config['debug_level'] = 1; +// log driver: 'syslog' or 'file'. +$rcmail_config['log_driver'] = 'file'; + +// date format for log entries +// (read http://php.net/manual/en/function.date.php for all format characters) +$rcmail_config['log_date_format'] = 'd-M-Y H:i:s O'; + +// Syslog ident string to use, if using the 'syslog' log driver. +$rcmail_config['syslog_id'] = 'roundcube'; + +// Syslog facility to use, if using the 'syslog' log driver. +// For possible values see installer or http://php.net/manual/en/function.openlog.php +$rcmail_config['syslog_facility'] = LOG_USER; + +// use this folder to store log files (must be writeable for apache user) +// This is used by the 'file' log driver. +$rcmail_config['log_dir'] = 'logs/'; + +// use this folder to store temp files (must be writeable for apache user) +$rcmail_config['temp_dir'] = 'temp/'; + +// List of active plugins (in plugins/ directory) +$rcmail_config['plugins'] = array(); + // enable caching of messages and mailbox data in the local database. // this is recommended if the IMAP server does not run on the same machine -$rcmail_config['enable_caching'] = TRUE; +$rcmail_config['enable_caching'] = FALSE; // lifetime of message cache // possible units: s, m, h, d, w $rcmail_config['message_cache_lifetime'] = '10d'; +// enforce connections over https +// with this option enabled, all non-secure connections will be redirected. +// set the port for the ssl connection as value of this option if it differs from the default 443 +$rcmail_config['force_https'] = FALSE; + // automatically create a new RoundCube user when log-in the first time. // a new user will be created once the IMAP login succeeds. // set to false if only registered users can use this service @@ -34,12 +62,21 @@ $rcmail_config['auto_create_user'] = TRUE; // the mail host chosen to perform the log-in // leave blank to show a textbox at login, give a list of hosts // to display a pulldown menu or set one host as string. -// To use SSL connection, enter ssl://hostname:993 +// To use SSL/TLS connection, enter hostname with prefix ssl:// or tls:// $rcmail_config['default_host'] = ''; // TCP port used for IMAP connections $rcmail_config['default_port'] = 143; +// IMAP auth type. Can be "auth" (CRAM-MD5), "plain" (PLAIN) or "check" to auto detect. +// Optional, defaults to "check" +$rcmail_config['imap_auth_type'] = null; + +// If you know your imap's root directory and its folder delimiter, +// you can specify them here. Otherwise they will be determined automatically. +$rcmail_config['imap_root'] = null; +$rcmail_config['imap_delimiter'] = null; + // Automatically add this domain to user names for login // Only for IMAP servers that require full e-mail addresses for login // Specify an array with 'host' => 'domain' values to support multiple hosts @@ -54,12 +91,14 @@ $rcmail_config['virtuser_file'] = ''; // Query to resolve user names and e-mail addresses from the database // %u will be replaced with the current username for login. -// The query should select the user's e-mail address as first col +// The query should select the user's e-mail address as first column +// and optional identity name as second column $rcmail_config['virtuser_query'] = ''; // use this host for sending mails. // to use SSL connection, set ssl://smtp.host.com // if left blank, the PHP mail() function is used +// Use %h variable as replacement for user's IMAP hostname $rcmail_config['smtp_server'] = ''; // SMTP port (default is 25; 465 for SSL) @@ -77,51 +116,72 @@ $rcmail_config['smtp_pass'] = ''; // best server supported one) $rcmail_config['smtp_auth_type'] = ''; +// SMTP HELO host +// Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages +// Leave this blank and you will get the server variable 'server_name' or +// localhost if that isn't defined. +$rcmail_config['smtp_helo_host'] = ''; + // Log sent messages $rcmail_config['smtp_log'] = TRUE; -// these cols are shown in the message list -// available cols are: subject, from, to, cc, replyto, date, size, encoding -$rcmail_config['list_cols'] = array('subject', 'from', 'date', 'size'); +// Log SQL queries to /sql or to syslog +$rcmail_config['sql_debug'] = false; -// relative path to the skin folder -$rcmail_config['skin_path'] = 'skins/default/'; +// Log IMAP conversation to /imap or to syslog +$rcmail_config['imap_debug'] = false; -// use this folder to store temp files (must be writebale for apache user) -$rcmail_config['temp_dir'] = 'temp/'; +// Log LDAP conversation to /ldap or to syslog +$rcmail_config['ldap_debug'] = false; -// use this folder to store log files (must be writebale for apache user) -$rcmail_config['log_dir'] = 'logs/'; +// Log SMTP conversation to /smtp or to syslog +$rcmail_config['smtp_debug'] = false; + +// How many seconds must pass between emails sent by a user +$rcmail_config['sendmail_delay'] = 0; + +// These cols are shown in the message list. Available cols are: +// subject, from, to, cc, replyto, date, size, flag, attachment +$rcmail_config['list_cols'] = array('subject', 'from', 'date', 'size', 'flag', 'attachment'); + +// Includes should be interpreted as PHP files +$rcmail_config['skin_include_php'] = FALSE; -// session lifetime in minutes +// Session lifetime in minutes +// must be greater than 'keep_alive'/60 $rcmail_config['session_lifetime'] = 10; // check client IP in session athorization -$rcmail_config['ip_check'] = TRUE; +$rcmail_config['ip_check'] = false; + +// Use an additional frequently changing cookie to athenticate user sessions. +// There have been problems reported with this feature. +$rcmail_config['double_auth'] = false; // this key is used to encrypt the users imap password which is stored // in the session record (and the client cookie if remember password is enabled). // please provide a string of exactly 24 chars. $rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str'; -// the default locale setting -$rcmail_config['locale_string'] = 'en'; +// the default locale setting (leave empty for auto-detection) +// RFC1766 formatted language name like en_US, de_DE, de_CH, fr_FR, pt_BR +$rcmail_config['language'] = null; -// use this format for short date display +// use this format for short date display (date or strftime format) $rcmail_config['date_short'] = 'D H:i'; -// use this format for detailed date/time formatting +// use this format for detailed date/time formatting (date or strftime format) $rcmail_config['date_long'] = 'd.m.Y H:i'; +// use this format for today's date display (date or strftime format) +$rcmail_config['date_today'] = 'H:i'; + // add this user-agent to message headers when sending -$rcmail_config['useragent'] = 'RoundCube Webmail/0.1b'; +$rcmail_config['useragent'] = 'RoundCube Webmail/'.RCMAIL_VERSION; // use this name to compose page titles $rcmail_config['product_name'] = 'RoundCube Webmail'; -// only list folders within this path -$rcmail_config['imap_root'] = ''; - // store draft message is this mailbox // leave blank if draft messages should not be stored $rcmail_config['drafts_mbox'] = 'Drafts'; @@ -138,83 +198,257 @@ $rcmail_config['sent_mbox'] = 'Sent'; $rcmail_config['trash_mbox'] = 'Trash'; // display these folders separately in the mailbox list. -// these folders will automatically be created if they do not exist +// these folders will also be displayed with localized names $rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash'); +// automatically create the above listed default folders on login +$rcmail_config['create_default_folders'] = FALSE; + // protect the default folders from renames, deletes, and subscription changes $rcmail_config['protect_default_folders'] = TRUE; -// Set TRUE if deleted messages should not be displayed -// This will make the application run slower -$rcmail_config['skip_deleted'] = FALSE; +// if in your system 0 quota means no limit set this option to TRUE +$rcmail_config['quota_zero_as_unlimited'] = FALSE; -// Set true to Mark deleted messages as read as well as deleted -// False means that a message's read status is not affected by marking it as deleted -$rcmail_config['read_when_deleted'] = TRUE; +// Behavior if a received message requests a message delivery notification (read receipt) +// 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask) +$rcmail_config['mdn_requests'] = 0; -// When a Trash folder is not present and a message is deleted, flag -// the message for deletion rather than deleting it immediately. Setting this to -// false causes deleted messages to be permanantly removed if there is no Trash folder -$rcmail_config['flag_for_deletion'] = TRUE; +// Use this charset as fallback for message decoding +$rcmail_config['default_charset'] = 'ISO-8859-1'; -// Make use of the built-in spell checker. It is based on GoogieSpell -// which means that the message content will be sent to Google in order to check spelling +// Make use of the built-in spell checker. It is based on GoogieSpell. +// Since Google only accepts connections over https your PHP installatation +// requires to be compiled with Open SSL support $rcmail_config['enable_spellcheck'] = TRUE; +// Set the spell checking engine. 'googie' is the default. 'pspell' is also available, +// but requires the Pspell extensions. When using Nox Spell Server, also set 'googie' here. +$rcmail_config['spellcheck_engine'] = 'googie'; + +// For a locally installed Nox Spell Server, please specify the URI to call it. +// Get Nox Spell Server from http://orangoo.com/labs/?page_id=72 +// Leave empty to use the Google spell checking service, what means +// that the message content will be sent to Google in order to check spelling +$rcmail_config['spellcheck_uri'] = ''; + +// These languages can be selected for spell checking. +// Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch'); +// Leave empty for default set of available language. +$rcmail_config['spellcheck_languages'] = NULL; + // path to a text file which will be added to each sent message // paths are relative to the RoundCube root folder $rcmail_config['generic_message_footer'] = ''; +// add a received header to outgoing mails containing the creators IP and hostname +$rcmail_config['http_received_header'] = false; + +// Whether or not to encrypt the IP address and the host name +// these could, in some circles, be considered as sensitive information; +// however, for the administrator, these could be invaluable help +// when tracking down issues. +$rcmail_config['http_received_header_encrypt'] = false; + // this string is used as a delimiter for message headers when sending // leave empty for auto-detection $rcmail_config['mail_header_delimiter'] = NULL; -// in order to enable public ldap search, create a config array -// like the Verisign example below. if you would like to test, -// simply uncomment the Verisign example. -/** - * example config for Verisign directory +// session domain: .example.org +$rcmail_config['session_domain'] = ''; + +// This indicates which type of address book to use. Possible choises: +// 'sql' (default) and 'ldap'. +// If set to 'ldap' then it will look at using the first writable LDAP +// address book as the primary address book and it will not display the +// SQL address book in the 'Address Book' view. +$rcmail_config['address_book_type'] = 'sql'; + +// In order to enable public ldap search, configure an array like the Verisign +// example further below. if you would like to test, simply uncomment the example. +$rcmail_config['ldap_public'] = array(); + +// +// If you are going to use LDAP for individual address books, you will need to +// set 'user_specific' to true and use the variables to generate the appropriate DNs to access it. +// +// The recommended directory structure for LDAP is to store all the address book entries +// under the users main entry, e.g.: +// +// o=root +// ou=people +// uid=user@domain +// mail=contact@contactdomain +// +// So the base_dn would be uid=%fu,ou=people,o=root +// The bind_dn would be the same as based_dn or some super user login. +/* + * example config for Verisign directory * - * $rcmail_config['ldap_public']['Verisign'] = array('hosts' => array('directory.verisign.com'), - * 'port' => 389, - * 'base_dn' => '', - * 'search_fields' => array('Email' => 'mail', 'Name' => 'cn'), - * 'name_field' => 'cn', - * 'mail_field' => 'mail', - * 'scope' => 'sub', - * 'fuzzy_search' => 0); - */ +$rcmail_config['ldap_public']['Verisign'] = array( + 'name' => 'Verisign.com', + 'hosts' => array('directory.verisign.com'), + 'port' => 389, + 'use_tls' => false, + 'user_specific' => false, // If true the base_dn, bind_dn and bind_pass default to the user's IMAP login. + // %fu - The full username provided, assumes the username is an email + // address, uses the username_domain value if not an email address. + // %u - The username prior to the '@'. + // %d - The domain name after the '@'. + 'base_dn' => '', + 'bind_dn' => '', + 'bind_pass' => '', + 'writable' => false, // Indicates if we can write to the LDAP directory or not. + // If writable is true then these fields need to be populated: + // LDAP_Object_Classes, required_fields, LDAP_rdn + 'LDAP_Object_Classes' => array("top", "inetOrgPerson"), // To create a new contact these are the object classes to specify (or any other classes you wish to use). + 'required_fields' => array("cn", "sn", "mail"), // The required fields needed to build a new contact as required by the object classes (can include additional fields not required by the object classes). + 'LDAP_rdn' => 'mail', // The RDN field that is used for new entries, this field needs to be one of the search_fields, the base of base_dn is appended to the RDN to insert into the LDAP directory. + 'ldap_version' => 3, // using LDAPv3 + 'search_fields' => array('mail', 'cn'), // fields to search in + 'name_field' => 'cn', // this field represents the contact's name + 'email_field' => 'mail', // this field represents the contact's e-mail + 'surname_field' => 'sn', // this field represents the contact's last name + 'firstname_field' => 'gn', // this field represents the contact's first name + 'sort' => 'cn', // The field to sort the listing by. + 'scope' => 'sub', // search mode: sub|base|list + 'filter' => '', // used for basic listing (if not empty) and will be &'d with search queries. example: status=act + 'fuzzy_search' => true); // server allows wildcard search +*/ + +// An ordered array of the ids of the addressbooks that should be searched +// when populating address autocomplete fields server-side. ex: array('sql','Verisign'); +$rcmail_config['autocomplete_addressbooks'] = array('sql'); + +// don't allow these settings to be overriden by the user +$rcmail_config['dont_override'] = array(); + +// Set identities access level: +// 0 - many identities with possibility to edit all params +// 1 - many identities with possibility to edit all params but not email address +// 2 - one identity with possibility to edit all params +// 3 - one identity with possibility to edit all params but not email address +$rcmail_config['identities_level'] = 0; // try to load host-specific configuration -$rcmail_config['include_host_config'] = FALSE; +// see http://trac.roundcube.net/wiki/Howto_Config for more details +$rcmail_config['include_host_config'] = false; + +// don't let users set pagesize to more than this value if set +$rcmail_config['max_pagesize'] = 200; + +// mime magic database +$rcmail_config['mime_magic'] = '/usr/share/misc/magic'; + +// default sort col +$rcmail_config['message_sort_col'] = 'date'; + +// default sort order +$rcmail_config['message_sort_order'] = 'DESC'; + +// THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA. +// ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING! +$rcmail_config['enable_installer'] = false; +// Log successful logins +$rcmail_config['log_logins'] = false; + +/** + * 'Delete always' + * This setting reflects if mail should be always marked as deleted, + * even if moving to "Trash" fails. This is necessary in some setups + * because a) people may not have a Trash folder or b) they are over + * quota (and Trash is included in the quota). + * + * This is a failover setting for iil_C_Move when a message is moved + * to the Trash. + */ +$rcmail_config['delete_always'] = false; + +// Minimal value of user's 'keep_alive' setting (in seconds) +// Must be less than 'session_lifetime' +$rcmail_config['min_keep_alive'] = 60; + +// Enable DNS checking for e-mail address validation +$rcmail_config['email_dns_check'] = false; /***** these settings can be overwritten by user's preferences *****/ +// skin name: folder from skins/ +$rcmail_config['skin'] = 'default'; + // show up to X items in list view $rcmail_config['pagesize'] = 40; // use this timezone to display date/time -$rcmail_config['timezone'] = 1; +$rcmail_config['timezone'] = 'auto'; -// daylight savings are On -$rcmail_config['dst_active'] = TRUE; +// is daylight saving On? +$rcmail_config['dst_active'] = (bool)date('I'); // prefer displaying HTML messages $rcmail_config['prefer_html'] = TRUE; +// display remote inline images +// 0 - Never, always ask +// 1 - Ask if sender is not in address book +// 2 - Always show inline images +$rcmail_config['show_images'] = 0; + +// compose html formatted messages by default +$rcmail_config['htmleditor'] = FALSE; + // show pretty dates as standard $rcmail_config['prettydate'] = TRUE; -// default sort col -$rcmail_config['message_sort_col'] = 'date'; +// save compose message every 300 seconds (5min) +$rcmail_config['draft_autosave'] = 300; -// default sort order -$rcmail_config['message_sort_order'] = 'DESC'; +// default setting if preview pane is enabled +$rcmail_config['preview_pane'] = FALSE; + +// focus new window if new message arrives +$rcmail_config['focus_on_new_message'] = true; + +// Clear Trash on logout +$rcmail_config['logout_purge'] = FALSE; + +// Compact INBOX on logout +$rcmail_config['logout_expunge'] = FALSE; + +// Display attached images below the message body +$rcmail_config['inline_images'] = TRUE; + +// Encoding of long/non-ascii attachment names: +// 0 - Full RFC 2231 compatible +// 1 - RFC 2047 for 'name' and RFC 2231 for 'filename' parameter (Thunderbird's default) +// 2 - Full 2047 compatible +$rcmail_config['mime_param_folding'] = 1; + +// Set TRUE if deleted messages should not be displayed +// This will make the application run slower +$rcmail_config['skip_deleted'] = FALSE; + +// Set true to Mark deleted messages as read as well as deleted +// False means that a message's read status is not affected by marking it as deleted +$rcmail_config['read_when_deleted'] = TRUE; + +// Set to TRUE to newer delete messages immediately +// Use 'Purge' to remove messages marked as deleted +$rcmail_config['flag_for_deletion'] = FALSE; + +// Default interval for keep-alive/check-recent requests (in seconds) +// Must be greater than or equal to 'min_keep_alive' and less than 'session_lifetime' +$rcmail_config['keep_alive'] = 60; + +// If true all folders will be checked for recent messages +$rcmail_config['check_all_folders'] = FALSE; -// list of configuration option names that need to be available in Javascript. -$rcmail_config['javascript_config'] = array('read_when_deleted', 'flag_for_deletion'); +// If true, after message delete/move, the next message will be displayed +$rcmail_config['display_next'] = FALSE; +// If true, messages list will be sorted by message index instead of message date +$rcmail_config['index_sort'] = TRUE; // end of config file ?>