]> git.donarmstrong.com Git - roundcube.git/blobdiff - config/main.inc.php.dist
Imported Upstream version 0.2~alpha
[roundcube.git] / config / main.inc.php.dist
index 2f79bd8e8f977037e19bc3c799aa7f34521de7b1..67d82c8693a06e55b27023ab43340527b343ded5 100644 (file)
@@ -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-2008, RoundCube Dev. - Switzerland                 |
  | Licensed under the GNU GPL                                            |
  |                                                                       |
  +-----------------------------------------------------------------------+
@@ -40,6 +40,10 @@ $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;
+
 // 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
@@ -77,6 +81,12 @@ $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;
 
@@ -87,6 +97,9 @@ $rcmail_config['list_cols'] = array('subject', 'from', 'date', 'size');
 // relative path to the skin folder
 $rcmail_config['skin_path'] = 'skins/default/';
 
+// 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/';
 
@@ -97,7 +110,11 @@ $rcmail_config['log_dir'] = 'logs/';
 $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).
@@ -105,7 +122,7 @@ $rcmail_config['ip_check'] = TRUE;
 $rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str';
 
 // the default locale setting
-$rcmail_config['locale_string'] = 'en';
+$rcmail_config['language'] = 'en';
 
 // use this format for short date display
 $rcmail_config['date_short'] = 'D H:i';
@@ -113,8 +130,11 @@ $rcmail_config['date_short'] = 'D H:i';
 // use this format for detailed date/time formatting
 $rcmail_config['date_long'] = 'd.m.Y H:i';
 
+// use this format for today's date display
+$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/0.2a';
 
 // use this name to compose page titles
 $rcmail_config['product_name'] = 'RoundCube Webmail';
@@ -138,9 +158,12 @@ $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;
 
@@ -157,37 +180,123 @@ $rcmail_config['read_when_deleted'] = TRUE;
 // false causes deleted messages to be permanantly removed if there is no Trash folder
 $rcmail_config['flag_for_deletion'] = TRUE;
 
-// 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
+// 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;
 
+// 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'] = '';
 
+// 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;
 
-// 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.
+// 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
+ * 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
+ *  'global_search' => true,    // perform a global search for address auto-completion on compose
+ *  'fuzzy_search'  => true);   // server allows wildcard search
  */
 
+// don't allow these settings to be overriden by the user
+$rcmail_config['dont_override'] = array();
+
 // 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;
 
 /***** these settings can be overwritten by user's preferences *****/
 
@@ -195,26 +304,46 @@ $rcmail_config['include_host_config'] = FALSE;
 $rcmail_config['pagesize'] = 40;
 
 // use this timezone to display date/time
-$rcmail_config['timezone'] = 1;
+$rcmail_config['timezone'] = intval(date('O'))/100 - date('I');
 
-// 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;
 
+// 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;
+
+// Clear Trash on logout
+$rcmail_config['logout_purge'] = FALSE;
 
-// list of configuration option names that need to be available in Javascript.
-$rcmail_config['javascript_config'] = array('read_when_deleted', 'flag_for_deletion');
+// Compact INBOX on logout
+$rcmail_config['logout_expunge'] = 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, and not the same as "delete_right_away".
+ */
+$rcmail_config['delete_always'] = false;
 
+// Log successful logins
+$rcmail_config['log_logins'] = false;
 
 // end of config file
 ?>