* conf.pl if at all possible. That is the easiest and cleanest way
* to configure.
*
+ * @copyright © 2000-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
* @package squirrelmail
* @subpackage config
*/
* This is the web page title that appears at the top of the browser window.
* @global string $org_title
*/
-$org_title = "SquirrelMail $version";
+$org_title = "SquirrelMail";
/**
* Signout page
* Provider URI
*
* Here you can set URL of the link displayed on the right side of main page.
- *
+ * When empty, this refers to the SquirrelMail About page.
* Link will be displayed only if you have $hide_sm_attributions
* option set to true.
* @global string $provider_uri
*/
-$provider_uri = 'http://www.squirrelmail.org/';
+$provider_uri = '';
/*** Server Settings ***/
/**
$smtpPort = 25;
/**
- * SquirrelMail header control
+ * SquirrelMail header encryption
+ *
+ * Encryption key allows to hide SquirrelMail Received: headers
+ * in outbound messages. Interface uses encryption key to encode
+ * username, remote address and proxied address, then stores encoded
+ * information in X-Squirrel-* headers.
*
- * Option can be used to disable Received: headers added by SquirrelMail.
- * This can increase user's privacy and solve problems with spam filters
- * that increase spam marks for dynamic dialup addresses.
+ * Warning: used encryption function is not bulletproof. When used
+ * with static encryption keys, it provides only minimal security
+ * measures and information can be decoded quickly.
*
- * If admin enables this setting, system should have some logging facility
- * or other tools to control users. SquirrelMail's Received: header provides
- * information, that can't be forged by webmail user.
- * @global bool $skip_SM_header
+ * Encoded information can be decoded with decrypt_headers.php script
+ * from SquirrelMail contrib/ directory.
+ * @global string $encode_header_key
+ * @since 1.5.1 and 1.4.5
*/
-$skip_SM_header = false;
+$encode_header_key = '';
/**
* Path to Sendmail
*
* 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
*
*
* 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
+ * uw
* other
*
* Please note that this changes only some of server settings.
$imap_server_type = 'other';
/**
- * Advanced IMAP authentication options control
+ * Secure IMAP connection controls
+ *
+ * 0 - use plain text connection,
+ * 1 - use imaps (adds tls:// prefix to hostname),
+ * 2 - use IMAP STARTTLS extension (rfc2595).
*
- * 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
+ * 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
*
- * 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
+ * 0 - use plain text connection,
+ * 1 - use ssmtp (adds tls:// prefix to hostname),
+ * 2 - use SMTP STARTTLS extension (rfc2487).
+ *
+ * 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
/**
* Path to the data/ directory
*
+ * You need to create this directory yourself (see INSTALL).
+ *
* It is a possible security hole to have a writable directory
* under the web server's root directory (ex: /home/httpd/html).
- * For this reason, it is possible to put the data directory
- * anywhere you would like. The path name can be absolute or
- * relative (to the config directory). It doesn't matter. Here
- * are two examples:
+ * 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:
- * $data_dir = '/usr/local/squirrelmail/data/';
+ * $data_dir = '/var/local/squirrelmail/data/';
*
* Relative (to main SM directory):
* $data_dir = SM_PATH . 'data/';
+ * (NOT recommended: you need to secure apache to make sure these
+ * files are not world readable)
+ *
* @global string $data_dir
*/
-$data_dir = SM_PATH . 'data/';
+$data_dir = '/var/local/squirrelmail/data';
/**
* Attachments directory
* list files in this directory. Confidential data might be laying
* around there.
* + Since the webserver is not able to list the files in the content
- * is also impossible for the webserver to delete files lying around
- * there for too long.
+ * is also impossible for the webserver to delete files lying around
+ * there for too long. You should have some script that deletes
+ * left over temp files.
* + It should probably be another directory than data_dir.
* @global string $attachment_dir
*/
* 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;
$edit_identity = true;
$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
+ * information.
+ *
+ * You can disable this header, if you think that it violates
+ * user's privacy or security. Please note, that setting will
+ * work only when users are not allowed to change their identity.
+ *
+ * See SquirrelMail bug tracker #847107 for more details about it.
+ * @global bool $hide_auth_header
+ * @since 1.5.1 and 1.4.5
+ */
+$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
$theme[40]['PATH'] = SM_PATH . 'themes/wood_theme.php';
$theme[40]['NAME'] = 'Wood';
+$theme[41]['PATH'] = SM_PATH . 'themes/bluesome.php';
+$theme[41]['NAME'] = 'Bluesome';
+
+$theme[42]['PATH'] = SM_PATH . 'themes/simple_green2.php';
+$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
/**
* Shared filebased address book
* @global string $abook_global_file
+ * @since 1.5.1 and 1.4.4
*/
$abook_global_file = '';
/**
* Writing into shared address book control
* @global bool $abook_global_file_writeable
+ * @since 1.5.1 and 1.4.4
*/
$abook_global_file_writeable = false;
+/**
+ * Listing of shared address book control
+ * @global bool $abook_global_file_listing
+ * @since 1.5.1
+ */
+$abook_global_file_listing = true;
+
/**
* MOTD
*
* the plugin directory name relative to the /plugins/ directory.
* For instance, for the 'sqclock' plugin, you'd put a line like
* the following.
- * $plugins[0] = 'sqclock';
- * $plugins[1] = 'attachment_common';
+ * $plugins[] = 'sqclock';
+ * $plugins[] = 'attachment_common';
*/
// Add list of enabled plugins here
*/
$prefs_dsn = '';
$prefs_table = 'userprefs';
+/**
+ * Preference key field
+ * @global string $prefs_key_field
+ */
$prefs_key_field = 'prefkey';
+/**
+ * Size of preference key field
+ * @global integer $prefs_key_size
+ * @since 1.5.1
+ */
+$prefs_key_size = 64;
+/**
+ * Preference owner field
+ * @global string $prefs_user_field
+ */
$prefs_user_field = 'user';
+/**
+ * Size of preference owner field
+ * @global integer $prefs_user_size
+ * @since 1.5.1
+ */
+$prefs_user_size = 128;
+/**
+ * Preference value field
+ * @global string $prefs_val_field
+ */
$prefs_val_field = 'prefval';
/**
- * Global sql database options
+ * Size of preference key field
+ * @global integer $prefs_val_size
+ * @since 1.5.1
+ */
+$prefs_val_size = 65536;
+
+/*** Global sql database options ***/
+/**
+ * DSN of global address book database
+ * @global string $addrbook_global_dsn
+ * @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 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 and 1.4.4
+ */
$addrbook_global_writeable = false;
+/**
+ * Control listing of global database address book
+ * @global boolean $addrbook_global_listing
+ * @since 1.5.1 and 1.4.4
+ */
$addrbook_global_listing = false;
/*** Language settings ***/
* 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
*/
$default_charset = 'iso-8859-1';
-/**
- * Available Languages
- *
- * This option controls number of languages available to end user in
- * language selection preferences. You can use space separated list
- * of translations installed in locale/ directory or special keys
- * 'all' (all languages are available) and 'none' (language selection
- * is disabled, interface is set to $squirrelmail_default_language
- * @global string $available_languages
- * @since 1.5.0
- */
-$available_languages = 'all';
-
/**
* Alternative Language Names Control
*
*/
$lossy_encoding = false;
-/*** Tweaks ***/
/**
- * Advanced DHTML tree control
- *
- * Use experimental DHTML folder listing
- * @global bool $advanced_tree
- * @since 1.5.0
+ * Controls use of time zone libraries
+ *
+ * Possible values:
+ * <ul>
+ * <li>0 - default, SquirrelMail uses GNU C timezone names in
+ * TZ environment variables
+ * <li>1 - strict, SquirrelMail uses 'TZ' subkey values in TZ
+ * environment variables
+ * <li>2 - custom, SquirrelMail loads time zone data from
+ * config/timezones.php and uses time zone array keys in
+ * TZ enviroment variables
+ * <li>3 - custom strict, SquirrelMail loads time zone data from
+ * config/timezones.php and uses TZ subkey values in
+ * TZ enviroment variables
+ * </ul>
+ * Use of any other value switches to default SquirrelMail time zone
+ * handling ($time_zone_type).
+ * @global integer $time_zone_type
+ * @since 1.5.1
*/
-$advanced_tree = false;
+$time_zone_type = 0;
+/*** Tweaks ***/
/**
- * Older listing way control
+ * Iframe sandbox code control
*
- * Use older way of folder listing
- * @global bool $oldway
+ * Use iframe to render html emails
+ * (temp option used during debuging of new code)
+ * @global bool $use_iframe
+ * @since 1.5.1
*/
-$oldway = false;
+$use_iframe = false;
/**
* Message Icons control
*
* Use icons for message and folder markers
* @global bool $use_icons
+ * @since 1.5.1
*/
$use_icons = false;
*/
$use_php_iconv = false;
+/**
+ * Controls remote configuration checks
+ * @global boolean $allow_remote_configtest
+ * @since 1.5.1
+ */
+$allow_remote_configtest = false;
+
/**
* Subscribe Listing Control
*
projects / squirrelmail.git / blobdiff