From 030c848b0d68321b711875886f90e680f232715b Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Thu, 11 Dec 2008 03:30:00 -0500
Subject: [PATCH] - Performance: allow setting imap rootdir and delimiter before connect (#1485172)
---
config/main.inc.php.dist | 372 ++++++++++++++++++++++++++++++++++++----------------
1 files changed, 255 insertions(+), 117 deletions(-)
diff --git a/config/main.inc.php.dist b/config/main.inc.php.dist
index 1ac688d..8b4fbad 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-2007, RoundCube Dev. - Switzerland |
+ | Copyright (C) 2005-2008, RoundCube Dev. - Switzerland |
| Licensed under the GNU GPL |
| |
+-----------------------------------------------------------------------+
@@ -17,6 +17,23 @@
// 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';
+
+// 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/';
// 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
@@ -39,6 +56,16 @@
// 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
+// during every imap connection.
+$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
@@ -86,23 +113,18 @@
// 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');
+// How many seconds must pass between emails sent by a user
+$rcmail_config['sendmail_delay'] = 0;
-// relative path to the skin folder
-$rcmail_config['skin_path'] = 'skins/default/';
+// These cols are shown in the message list. Available cols are:
+// subject, from, to, cc, replyto, date, size, encoding, flag, attachment
+$rcmail_config['list_cols'] = array('subject', 'from', 'date', 'size', 'flag', 'attachment');
-// includes should be interpreted as PHP files
+// Includes should be interpreted as PHP files
$rcmail_config['skin_include_php'] = FALSE;
-// use this folder to store temp files (must be writebale for apache user)
-$rcmail_config['temp_dir'] = 'temp/';
-
-// use this folder to store log files (must be writebale for apache user)
-$rcmail_config['log_dir'] = 'logs/';
-
-// 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
@@ -117,8 +139,9 @@
// 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
$rcmail_config['date_short'] = 'D H:i';
@@ -130,13 +153,10 @@
$rcmail_config['date_today'] = 'H:i';
// add this user-agent to message headers when sending
-$rcmail_config['useragent'] = 'RoundCube Webmail/0.1';
+$rcmail_config['useragent'] = 'RoundCube Webmail/0.2-beta';
// 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
@@ -154,7 +174,7 @@
$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
@@ -162,6 +182,214 @@
// protect the default folders from renames, deletes, and subscription changes
$rcmail_config['protect_default_folders'] = TRUE;
+
+// if in your system 0 quota means no limit set this option to TRUE
+$rcmail_config['quota_zero_as_unlimited'] = FALSE;
+
+// 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;
+
+// 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.
+// 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 Google spell check languages, should be defined
+// when using local Pspell extension
+$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;
+
+// this string is used as a delimiter for message headers when sending
+// leave empty for auto-detection
+$rcmail_config['mail_header_delimiter'] = NULL;
+
+// 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.
+//
+// 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(
+ * '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
+// 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;
+
+/***** 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'] = 'auto';
+
+// 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;
+
+// save compose message every 300 seconds (5min)
+$rcmail_config['draft_autosave'] = 300;
+
+// 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'] = 0;
// Set TRUE if deleted messages should not be displayed
// This will make the application run slower
@@ -174,104 +402,14 @@
// 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;
+$rcmail_config['flag_for_deletion'] = FALSE;
-// 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;
+// 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;
-// 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;
-
-// 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 Google spell check languages
-$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'] = '';
-
-// 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
- *
- * $rcmail_config['ldap_public']['Verisign'] = array(
- * 'name' => 'Verisign.com',
- * 'hosts' => array('directory.verisign.com'),
- * 'port' => 389,
- * 'base_dn' => '',
- * 'bind_dn' => '',
- * 'bind_pass' => '',
- * '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
- * 'scope' => 'sub', // search mode: sub|base|list
- * 'filter' => '', // used for basic listing (if not empty) and will be &'d with search queries. ex: (status=act)
- * 'fuzzy_search' => true); // server allows wildcard search
- */
-
-// don't allow these settings to be overriden by the user
-$rcmail_config['dont_override'] = array();
-
-// list of configuration option names that need to be available in Javascript.
-$rcmail_config['javascript_config'] = array('read_when_deleted', 'flag_for_deletion');
-
-// try to load host-specific configuration
-$rcmail_config['include_host_config'] = FALSE;
-
-
-/***** these settings can be overwritten by user's preferences *****/
-
-// show up to X items in list view
-$rcmail_config['pagesize'] = 40;
-
-// use this timezone to display date/time
-$rcmail_config['timezone'] = intval(date('O'))/100 - date('I');
-
-// is daylight saving On?
-$rcmail_config['dst_active'] = (bool)date('I');
-
-// prefer displaying HTML messages
-$rcmail_config['prefer_html'] = TRUE;
-
-// compose html formatted messages by default
-$rcmail_config['htmleditor'] = TRUE;
-
-// show pretty dates as standard
-$rcmail_config['prettydate'] = TRUE;
-
-// default sort col
-$rcmail_config['message_sort_col'] = 'date';
-
-// default sort order
-$rcmail_config['message_sort_order'] = 'DESC';
-
-// save compose message every 300 seconds (5min)
-$rcmail_config['draft_autosave'] = 300;
-
-// default setting if preview pane is enabled
-$rcmail_config['preview_pane'] = FALSE;
-
-// don't let users set pagesize to more than this value if set
-$rcmail_config['max_pagesize'] = 200;
+// If true all folders will be checked for recent messages
+$rcmail_config['check_all_folders'] = FALSE;
// end of config file
?>
--
Gitblit v1.9.1