data and attachment directories need trailing slash. If we don't require it,
[squirrelmail.git] / config / config_default.php
index cdeb9a36801fa0c1696f111d25ac8a95465a5a56..a5aaed212b62f6dc9c42a9c1d90eb36c35e6a5d9 100644 (file)
  * conf.pl if at all possible.  That is the easiest and cleanest way
  * to configure.
  *
+ * Note on SECURITY: some options require putting a password in this file.
+ * Please make sure that you adapt its permissions appropriately to avoid
+ * passwords being leaked to e.g. other system users. Take extra care when
+ * the webserver is shared with untrusted users.
+ *
+ * @copyright © 2000-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
  * @package squirrelmail
  * @subpackage config
  */
@@ -166,11 +174,25 @@ $encode_header_key = '';
  *
  * Program that should be used when sending email. SquirrelMail expects that
  * this program will follow options used by original sendmail
- * (http://www.sendmail.org).
+ * (http://www.sendmail.org). Support of -f argument is required.
  * @global string $sendmail_path
  */
 $sendmail_path = '/usr/sbin/sendmail';
 
+/**
+ * Extra sendmail command arguments.
+ *
+ * Sets additional sendmail command arguments. Make sure that arguments are
+ * supported by your sendmail program. -f argument is added automatically by
+ * SquirrelMail scripts. Variable defaults to standard /usr/sbin/sendmail
+ * arguments. If you use qmail-inject, nbsmtp or any other sendmail wrapper,
+ * which does not support -t and -i arguments, set variable to empty string
+ * or use arguments suitable for your mailer.
+ * @global string $sendmail_args
+ * @since 1.5.1
+ */
+$sendmail_args = '-i -t';
+
 /**
  * IMAP server address
  *
@@ -192,14 +214,15 @@ $imapPort = 143;
  *
  * The type of IMAP server you are running.
  * Valid type are the following (case is important):
+ *   bincimap
  *   courier
  *   cyrus
+ *   dovecot
  *   exchange
- *   uw
- *   macosx
  *   hmailserver
+ *   macosx
  *   mercury32
- *   dovecot
+ *   uw
  *   other
  *
  * Please note that this changes only some of server settings.
@@ -211,22 +234,30 @@ $imapPort = 143;
 $imap_server_type = 'other';
 
 /**
- * Advanced IMAP authentication options control
+ * Secure IMAP connection controls
  *
- * CRAM-MD5, DIGEST-MD5, Plain, and TLS
- * Set reasonable defaults - you'd never know this was there unless you ask for it
- * @global bool $use_imap_tls
+ * 0 - use plain text connection,
+ * 1 - use imaps (adds tls:// prefix to hostname),
+ * 2 - use IMAP STARTTLS extension (rfc2595).
+ *
+ * Was boolean before 1.5.1.
+ * @global integer $use_imap_tls
+ * @since 1.4.0
  */
-$use_imap_tls = false;
+$use_imap_tls = 0;
 
 /**
- * Advanced SMTP authentication options control
+ * Secure SMTP connection controls
+ *
+ * 0 - use plain text connection,
+ * 1 - use ssmtp (adds tls:// prefix to hostname),
+ * 2 - use SMTP STARTTLS extension (rfc2487).
  *
- * CRAM-MD5, DIGEST-MD5, Plain, and TLS
- * Set reasonable defaults - you'd never know this was there unless you ask for it
- * @global bool $use_smtp_tls
+ * Was boolean before 1.5.1.
+ * @global integer $use_smtp_tls
+ * @since 1.4.0
  */
-$use_smtp_tls = false;
+$use_smtp_tls = 0;
 
 /**
  * SMTP authentication mechanism
@@ -430,6 +461,7 @@ $noselect_fix_enable = false;
  *   It is a possible security hole to have a writable directory
  *   under the web server's root directory (ex: /home/httpd/html).
  *   The path name can be absolute or relative (to the config directory).
+ *   If path is relative, it must use SM_PATH constant.
  *   Here are two examples:
  *
  * Absolute:
@@ -442,7 +474,7 @@ $noselect_fix_enable = false;
  *
  * @global string $data_dir
  */
-$data_dir = '/var/local/squirrelmail/data';
+$data_dir = '/var/local/squirrelmail/data/';
 
 /**
  * Attachments directory
@@ -461,7 +493,7 @@ $data_dir = '/var/local/squirrelmail/data';
  *    + It should probably be another directory than data_dir.
  * @global string $attachment_dir
  */
-$attachment_dir = $data_dir;
+$attachment_dir = '/var/local/squirrelmail/attach/';
 
 /**
  * Hash level used for data directory.
@@ -510,6 +542,7 @@ $default_use_priority = true;
  * This option disables display of "created by SquirrelMail developers"
  * strings and provider link
  * @global bool $hide_sm_attributions
+ * @since 1.2.0
  */
 $hide_sm_attributions = false;
 
@@ -537,8 +570,8 @@ $edit_name = true;
 
 /**
  * SquirrelMail adds username information to every sent email.
- * It is done in order to prevent possible sender forging when 
- * end users are allowed to change their email and name 
+ * It is done in order to prevent possible sender forging when
+ * end users are allowed to change their email and name
  * information.
  *
  * You can disable this header, if you think that it violates
@@ -554,22 +587,29 @@ $hide_auth_header = false;
 /**
  * Server Side Threading Control
  *
- * If you want to enable server side thread sorting options
- * Your IMAP server must support the THREAD extension for
- * this to work.
- * @global bool $allow_thread_sort
+ * Set it to true, if you want to disable server side thread 
+ * sorting options. Your IMAP server must support the THREAD 
+ * extension for this to have any effect.
+ * 
+ * Older SquirrelMail versions used $allow_thread_sort option.
+ * @global bool $disable_thread_sort
+ * @since 1.5.1
  */
-$allow_thread_sort = false;
+$disable_thread_sort = false;
 
 /**
  * Server Side Sorting Control
  *
- * to use server-side sorting instead of SM client side.
- * Your IMAP server must support the SORT extension for this
- * to work.
- * @global bool $allow_server_sort
+ * Set it to true, if you want to disable server side sorting 
+ * and use SM client side sorting instead (client side sorting 
+ * can be slow). Your IMAP server must support the SORT extension 
+ * for this to have any effect.
+ * 
+ * Older SquirrelMail versions used $allow_server_sort option.
+ * @global bool $disable_server_sort
+ * @since 1.5.1
  */
-$allow_server_sort = false;
+$disable_server_sort = false;
 
 /**
  * IMAP Charset Use Control
@@ -755,6 +795,77 @@ $theme[42]['NAME'] = 'Simple Green 2';
 $theme[43]['PATH'] = SM_PATH . 'themes/simple_purple.php';
 $theme[43]['NAME'] = 'Simple Purple';
 
+$theme[44]['PATH'] = SM_PATH . 'themes/autumn.php';
+$theme[44]['NAME'] = 'Autumn';
+
+$theme[45]['PATH'] = SM_PATH . 'themes/autumn2.php';
+$theme[45]['NAME'] = 'Autumn 2';
+
+$theme[46]['PATH'] = SM_PATH . 'themes/blue_on_blue.php';
+$theme[46]['NAME'] = 'Blue on Blue';
+
+$theme[47]['PATH'] = SM_PATH . 'themes/classic_blue.php';
+$theme[47]['NAME'] = 'Classic Blue';
+
+$theme[48]['PATH'] = SM_PATH . 'themes/classic_blue2.php';
+$theme[48]['NAME'] = 'Classic Blue 2';
+
+$theme[49]['PATH'] = SM_PATH . 'themes/powder_blue.php';
+$theme[49]['NAME'] = 'Powder Blue';
+
+$theme[50]['PATH'] = SM_PATH . 'themes/techno_blue.php';
+$theme[50]['NAME'] = 'Techno Blue';
+
+$theme[51]['PATH'] = SM_PATH . 'themes/turquoise.php';
+$theme[51]['NAME'] = 'Turquoise';
+
+/**
+ * Templates
+ *   You can define your own template and put it in this directory.
+ *   You must call it as the example below. You can name the template
+ *   whatever you want. For an example of a template, see the ones
+ *   included in the template directory.
+ *
+ * To add a new template to the options that users can choose from, just
+ * add a new number to the array at the bottom, and follow the pattern.
+ *
+ * $templateset_default sets theme that will be used by default
+ * used by default.
+ * @global integer $templateset_default
+ */
+$templateset_default = 0;
+
+$aTemplateSet[0]['PATH'] = SM_PATH . 'templates/default/';
+$aTemplateSet[0]['NAME'] = 'Default template';
+$aTemplateSet[1]['PATH'] = SM_PATH . 'templates/default_advanced/';
+$aTemplateSet[1]['NAME'] = 'Advanced template';
+
+/**
+ * Default interface font size.
+ * @global string $default_fontsize
+ * @since 1.5.1
+ */
+$default_fontsize = '';
+
+/**
+ * Default font set
+ * @global string $default_fontset
+ * @since 1.5.1
+ */
+$default_fontset = '';
+
+/**
+ * List of available fontsets.
+ * @global array $fontsets
+ * @since 1.5.1
+ */
+$fontsets = array();
+$fontsets['serif'] = 'serif';
+$fontsets['sans'] = 'helvetica,arial,sans-serif';
+$fontsets['comicsans'] = 'comic sans ms,sans-serif';
+$fontsets['verasans'] = 'bitstream vera sans,verdana,sans-serif';
+$fontsets['tahoma'] = 'tahoma,sans-serif';
+
 /**
  * LDAP server(s)
  *   Array of arrays with LDAP server parameters. See
@@ -767,6 +878,9 @@ $theme[43]['NAME'] = 'Simple Purple';
  *       'name' => 'Netcenter Member Directory',
  *       'base' => 'ou=member_directory,o=netcenter.com'
  *   );
+ *
+ *   NOTE: please see security note at the top of this file when
+ *   entering a password.
  */
 // Add your ldap server options here
 
@@ -803,6 +917,24 @@ $abook_global_file_writeable = false;
  */
 $abook_global_file_listing = true;
 
+/**
+ * Controls file based address book entry size
+ * 
+ * This setting controls space allocated to file based address book records.
+ * End users will be unable to save address book entry, if total entry size 
+ * (quoted address book fields + 4 delimiters + linefeed) exceeds allowed
+ * address book length size.
+ *
+ * Same setting is applied to personal and global file based address books.
+ *
+ * It is strongly recommended to keep default setting value. Change it only
+ * if you really want to store address book entries that are bigger than two
+ * kilobytes (2048).
+ * @global integer $abook_file_line_length
+ * @since 1.5.2
+ */
+$abook_file_line_length = 2048;
+
 /**
  * MOTD
  *
@@ -837,6 +969,9 @@ $motd = "";
  *   The DSN is in the format: mysql://user:pass@hostname/dbname
  *   The table is the name of the table to use within the
  *   specified database.
+ *
+ *   NOTE: please see security note at the top of this file when
+ *   entering a password.
  */
 $addrbook_dsn = '';
 $addrbook_table = 'address';
@@ -846,7 +981,7 @@ $addrbook_table = 'address';
 $prefs_dsn = '';
 $prefs_table = 'userprefs';
 /**
- * Preference key field 
+ * Preference key field
  * @global string $prefs_key_field
  */
 $prefs_key_field = 'prefkey';
@@ -857,7 +992,7 @@ $prefs_key_field = 'prefkey';
  */
 $prefs_key_size = 64;
 /**
- * Preference owner field 
+ * Preference owner field
  * @global string $prefs_user_field
  */
 $prefs_user_field = 'user';
@@ -868,7 +1003,7 @@ $prefs_user_field = 'user';
  */
 $prefs_user_size = 128;
 /**
- * Preference value field 
+ * Preference value field
  * @global string $prefs_val_field
  */
 $prefs_val_field = 'prefval';
@@ -883,25 +1018,25 @@ $prefs_val_size = 65536;
 /**
  * DSN of global address book database
  * @global string $addrbook_global_dsn
- * @since 1.5.1
+ * @since 1.5.1 and 1.4.4
  */
 $addrbook_global_dsn = '';
 /**
  * Table used for global database address book
  * @global string $addrbook_global_table
- * @since 1.5.1
+ * @since 1.5.1 and 1.4.4
  */
 $addrbook_global_table = 'global_abook';
 /**
  * Control writing into global database address book
  * @global boolean $addrbook_global_writeable
- * @since 1.5.1
+ * @since 1.5.1 and 1.4.4
  */
 $addrbook_global_writeable = false;
 /**
  * Control listing of global database address book
  * @global boolean $addrbook_global_listing
- * @since 1.5.1
+ * @since 1.5.1 and 1.4.4
  */
 $addrbook_global_listing = false;
 
@@ -923,7 +1058,7 @@ $squirrelmail_default_language = 'en_US';
  * This option controls what character set is used when sending
  * mail and when sending HTML to the browser. Option works only
  * with US English (en_US) translation. Other translations use
- * charsets that are set in functions/i18n.php.
+ * charsets that are set in translation settings.
  *
  * @global string $default_charset
  */
@@ -984,16 +1119,30 @@ $lossy_encoding = false;
  */
 $time_zone_type = 0;
 
-/*** Tweaks ***/
 /**
- * Advanced DHTML tree control
+ * Location base
+ * 
+ * This is used to build the URL to the SquirrelMail location.
+ * It should contain only the protocol and hostname/port parts
+ * of the URL; the full path will be appended automatically.
  *
- * Use experimental DHTML folder listing
- * @global bool $advanced_tree
- * @since 1.5.0
+ * If not specified or empty, it will be autodetected.
+ *
+ * Examples:
+ * http://webmail.example.org
+ * http://webmail.example.com:8080
+ * https://webmail.example.com:6691
+ *
+ * To be clear: do not include any of the path elements, so if
+ * SquirrelMail is at http://www.example.net/web/mail/src/login.php, you
+ * write: http://www.example.net
+ *
+ * @global string $config_location_base;
+ * @since 1.5.2
  */
-$advanced_tree = false;
+$config_location_base = '';
 
+/*** Tweaks ***/
 /**
  * Iframe sandbox code control
  *
@@ -1075,11 +1224,3 @@ $config_use_color = 2;
  */
 @include SM_PATH . 'config/config_local.php';
 
-/**
- * Make sure there are no characters after the PHP closing
- * tag below (including newline characters and whitespace).
- * Otherwise, that character will cause the headers to be
- * sent and regular output to begin, which will majorly screw
- * things up when we try to send more headers later.
- */
-?>