* conf.pl if at all possible. That is the easiest and cleanest way
* to configure.
*
- * @copyright © 2000-2006 The SquirrelMail Project Team
+ * 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-2010 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
*/
/* Do not change this value. */
-global $version;
global $config_version;
-$config_version = '1.4.0';
+$config_version = '1.5.0';
/*** Organization preferences ***/
/**
/**
* Provider name
*
- * Here you can set name of the link displayed on the right side of main page.
+ * Here you can set the text of the link displayed on the top-right
+ * of the message list.
+ *
+ * Defaults to empty (no link).
*
- * Link will be displayed only if you have $hide_sm_attributions
- * option set to true.
* @global string $provider_name
*/
-$provider_name = 'SquirrelMail';
+$provider_name = '';
/**
* 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.
+ * Here you can set URL of the link displayed on the top-right of
+ * the message list.
+ *
+ * Defaults to empty (no link).
+ *
* @global string $provider_uri
*/
$provider_uri = '';
* 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
+ * @since 1.5.1 and 1.4.8
*/
$sendmail_args = '-i -t';
*/
$smtp_auth_mech = 'none';
+/**
+ * Custom SMTP authentication username
+ *
+ * IMAP username is used if variable is set to empty string.
+ * Variable is included in main configuration file only from 1.5.2 version.
+ * Older versions stored it in config_local.php.
+ * @global string $smtp_sitewide_user
+ * @since 1.5.0
+ */
+$smtp_sitewide_user = '';
+
+/**
+ * Custom SMTP authentication password
+ *
+ * IMAP password is used if $smtp_sitewide_user global is set to empty string.
+ * Variable is included in main configuration file only from 1.5.2 version.
+ * Older versions stored it in config_local.php.
+ * @global string $smtp_sitewide_pass
+ * @since 1.5.0
+ */
+$smtp_sitewide_pass = '';
+
/**
* IMAP authentication mechanism
*
*/
$pop_before_smtp = false;
+/**
+ * POP before SMTP server address
+ *
+ * When using POP3 before SMTP, if the POP server address is
+ * not the same as the SMTP server address, specify it here.
+ * If this is left empty, the SMTP server address will be
+ * used by default.
+ * @global bool $pop_before_smtp_host
+ */
+$pop_before_smtp_host = '';
+
/*** Folder Settings ***/
/**
*
* @global string $data_dir
*/
-$data_dir = '/var/local/squirrelmail/data';
+$data_dir = '/var/local/squirrelmail/data/';
/**
* Attachments directory
* + 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.
* SquirrelMail Attributions Control
*
* This option disables display of "created by SquirrelMail developers"
- * strings and provider link
+ * strings and links.
* @global bool $hide_sm_attributions
* @since 1.2.0
*/
/**
- * Themes
- * You can define your own theme and put it in this directory.
+ * User Themes
+ * You can define your own theme and put it in directory in SM_PATH/css/.
* You must call it as the example below. You can name the theme
- * whatever you want. For an example of a theme, see the ones
- * included in the config directory.
+ * whatever you want.
*
* To add a new theme to the options that users can choose from, just
* add a new number to the array at the bottom, and follow the pattern.
*
- * $theme_default sets theme that will be used by default
- * $theme_css sets stylesheet (from theme/css directory) that will be
- * used by default.
- * @global integer $theme_default
- * @global string $theme_css
+ * $user_theme_default sets theme that will be used by default
+ *
+ * @global integer $user_theme_default
+ * @since 1.5.2
*/
-$theme_default = 0;
-$theme_css = '';
+$user_theme_default = 0;
/**
* Listing of installed themes
- * @global array $theme
+ * @global array $user_themes
+ * @since 1.5.2
*/
-$theme[0]['PATH'] = SM_PATH . 'themes/default_theme.php';
-$theme[0]['NAME'] = 'Default';
-
-$theme[1]['PATH'] = SM_PATH . 'themes/plain_blue_theme.php';
-$theme[1]['NAME'] = 'Plain Blue';
-
-$theme[2]['PATH'] = SM_PATH . 'themes/sandstorm_theme.php';
-$theme[2]['NAME'] = 'Sand Storm';
-
-$theme[3]['PATH'] = SM_PATH . 'themes/deepocean_theme.php';
-$theme[3]['NAME'] = 'Deep Ocean';
-
-$theme[4]['PATH'] = SM_PATH . 'themes/slashdot_theme.php';
-$theme[4]['NAME'] = 'Slashdot';
-
-$theme[5]['PATH'] = SM_PATH . 'themes/purple_theme.php';
-$theme[5]['NAME'] = 'Purple';
-
-$theme[6]['PATH'] = SM_PATH . 'themes/forest_theme.php';
-$theme[6]['NAME'] = 'Forest';
-
-$theme[7]['PATH'] = SM_PATH . 'themes/ice_theme.php';
-$theme[7]['NAME'] = 'Ice';
-
-$theme[8]['PATH'] = SM_PATH . 'themes/seaspray_theme.php';
-$theme[8]['NAME'] = 'Sea Spray';
-
-$theme[9]['PATH'] = SM_PATH . 'themes/bluesteel_theme.php';
-$theme[9]['NAME'] = 'Blue Steel';
-
-$theme[10]['PATH'] = SM_PATH . 'themes/dark_grey_theme.php';
-$theme[10]['NAME'] = 'Dark Grey';
-
-$theme[11]['PATH'] = SM_PATH . 'themes/high_contrast_theme.php';
-$theme[11]['NAME'] = 'High Contrast';
-
-$theme[12]['PATH'] = SM_PATH . 'themes/black_bean_burrito_theme.php';
-$theme[12]['NAME'] = 'Black Bean Burrito';
-
-$theme[13]['PATH'] = SM_PATH . 'themes/servery_theme.php';
-$theme[13]['NAME'] = 'Servery';
+$user_themes[0]['PATH'] = 'none';
+$user_themes[0]['NAME'] = 'Default';
-$theme[14]['PATH'] = SM_PATH . 'themes/maize_theme.php';
-$theme[14]['NAME'] = 'Maize';
+$user_themes[1]['PATH'] = '../css/blue_gradient/';
+$user_themes[1]['NAME'] = 'Blue Options';
-$theme[15]['PATH'] = SM_PATH . 'themes/bluesnews_theme.php';
-$theme[15]['NAME'] = 'BluesNews';
-
-$theme[16]['PATH'] = SM_PATH . 'themes/deepocean2_theme.php';
-$theme[16]['NAME'] = 'Deep Ocean 2';
-
-$theme[17]['PATH'] = SM_PATH . 'themes/blue_grey_theme.php';
-$theme[17]['NAME'] = 'Blue Grey';
-
-$theme[18]['PATH'] = SM_PATH . 'themes/dompie_theme.php';
-$theme[18]['NAME'] = 'Dompie';
-
-$theme[19]['PATH'] = SM_PATH . 'themes/methodical_theme.php';
-$theme[19]['NAME'] = 'Methodical';
-
-$theme[20]['PATH'] = SM_PATH . 'themes/greenhouse_effect.php';
-$theme[20]['NAME'] = 'Greenhouse Effect (Changes)';
-
-$theme[21]['PATH'] = SM_PATH . 'themes/in_the_pink.php';
-$theme[21]['NAME'] = 'In The Pink (Changes)';
-
-$theme[22]['PATH'] = SM_PATH . 'themes/kind_of_blue.php';
-$theme[22]['NAME'] = 'Kind of Blue (Changes)';
-
-$theme[23]['PATH'] = SM_PATH . 'themes/monostochastic.php';
-$theme[23]['NAME'] = 'Monostochastic (Changes)';
-
-$theme[24]['PATH'] = SM_PATH . 'themes/shades_of_grey.php';
-$theme[24]['NAME'] = 'Shades of Grey (Changes)';
-
-$theme[25]['PATH'] = SM_PATH . 'themes/spice_of_life.php';
-$theme[25]['NAME'] = 'Spice of Life (Changes)';
-
-$theme[26]['PATH'] = SM_PATH . 'themes/spice_of_life_lite.php';
-$theme[26]['NAME'] = 'Spice of Life - Lite (Changes)';
-
-$theme[27]['PATH'] = SM_PATH . 'themes/spice_of_life_dark.php';
-$theme[27]['NAME'] = 'Spice of Life - Dark (Changes)';
-
-$theme[28]['PATH'] = SM_PATH . 'themes/christmas.php';
-$theme[28]['NAME'] = 'Holiday - Christmas';
-
-$theme[29]['PATH'] = SM_PATH . 'themes/darkness.php';
-$theme[29]['NAME'] = 'Darkness (Changes)';
-
-$theme[30]['PATH'] = SM_PATH . 'themes/random.php';
-$theme[30]['NAME'] = 'Random (Changes every login)';
-
-$theme[31]['PATH'] = SM_PATH . 'themes/midnight.php';
-$theme[31]['NAME'] = 'Midnight';
-
-$theme[32]['PATH'] = SM_PATH . 'themes/alien_glow.php';
-$theme[32]['NAME'] = 'Alien Glow';
-
-$theme[33]['PATH'] = SM_PATH . 'themes/dark_green.php';
-$theme[33]['NAME'] = 'Dark Green';
-
-$theme[34]['PATH'] = SM_PATH . 'themes/penguin.php';
-$theme[34]['NAME'] = 'Penguin';
-
-$theme[35]['PATH'] = SM_PATH . 'themes/minimal_bw.php';
-$theme[35]['NAME'] = 'Minimal BW';
-
-$theme[36]['PATH'] = SM_PATH . 'themes/redmond.php';
-$theme[36]['NAME'] = 'Redmond';
-
-$theme[37]['PATH'] = SM_PATH . 'themes/netstyle_theme.php';
-$theme[37]['NAME'] = 'Net Style';
-
-$theme[38]['PATH'] = SM_PATH . 'themes/silver_steel_theme.php';
-$theme[38]['NAME'] = 'Silver Steel';
-
-$theme[39]['PATH'] = SM_PATH . 'themes/simple_green_theme.php';
-$theme[39]['NAME'] = 'Simple Green';
-
-$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';
+/**
+ * Message Icons control
+ *
+ * Use icons for message and folder markers
+ * @global bool $use_icons
+ * @since 1.5.1
+ */
+$use_icons = true;
-$theme[47]['PATH'] = SM_PATH . 'themes/classic_blue.php';
-$theme[47]['NAME'] = 'Classic Blue';
+/**
+ * Icon Themes
+ * You can create your own icon themes and put them in a directory in
+ * SM_PATH/images/themes/. Your users will be able to choose whatever
+ * icon themes are listed below.
+ *
+ * To add a new theme to the list of available icon themes, just add a new
+ * number to the array below and follow the pattern
+ *
+ * $icon_theme_default sets the theme that will be used by default.
+ * $icon_theme_fallback specifies which theme will be used if an icon is
+ * not found in the selected theme
+ *
+ * @global integer $icon_theme_def
+ * @global integer $icon_theme_fallback
+ * @since 1.5.2
+ */
+$icon_theme_def = 1;
+$icon_theme_fallback = 3;
-$theme[48]['PATH'] = SM_PATH . 'themes/classic_blue2.php';
-$theme[48]['NAME'] = 'Classic Blue 2';
+/**
+ * Listing of installed icon themes
+ * @global array $icon_themes
+ * @since 1.5.2
+ */
+$icon_themes[0]['PATH'] = 'none';
+$icon_themes[0]['NAME'] = 'No Icons';
-$theme[49]['PATH'] = SM_PATH . 'themes/powder_blue.php';
-$theme[49]['NAME'] = 'Powder Blue';
+$icon_themes[1]['PATH'] = 'template';
+$icon_themes[1]['NAME'] = 'Template Default Icons';
-$theme[50]['PATH'] = SM_PATH . 'themes/techno_blue.php';
-$theme[50]['NAME'] = 'Techno Blue';
+$icon_themes[2]['PATH'] = '../images/themes/default/';
+$icon_themes[2]['NAME'] = 'Default Icon Set';
-$theme[51]['PATH'] = SM_PATH . 'themes/turquoise.php';
-$theme[51]['NAME'] = 'Turquoise';
+$icon_themes[3]['PATH'] = '../images/themes/xp/';
+$icon_themes[3]['NAME'] = 'XP Style Icons';
/**
* 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.
+ * You can define your own template set (skin) and put it in a new
+ * directory under SM_PATH/templates. The ID must match the name of
+ * the template directory as the example below. You can name the
+ * template whatever you want. For an example of a template, see
+ * the ones included in the SM_PATH/templates 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';
+ * $templateset_default sets the skin that will be used by default
+ * when a user doesn't have a skin selection
+ * in their preferences. (Must be the "ID" of
+ * the desired template set)
+ *
+ * $templateset_fallback tells SquirrelMail which template set (skin)
+ * to use when looking for a file that is not
+ * contained within whatever skin is currently
+ * being used. (Must be the "ID" of the desired
+ * template set)
+ *
+ * $rpc_templateset sets the skin that will be used by default
+ * when a user is making an RPC request. This
+ * does not usually need to be changed, but
+ * can be used to change the RPC protocol that
+ * is used to respond to RPC requets. (Must be
+ * the "ID" of the desired template set and
+ * should NOT be a template set that is included
+ * in the $aTemplateSet list; PLEASE NOTE that
+ * new RPC template sets should always be named
+ * "<skin name>_rpc", as SquirrelMail will assume
+ * any template sets ending in "_rpc" are intended
+ * for its RPC interface only)
+ *
+ * @global string $templateset_default
+ * @global string $templateset_fallback
+ * @global string $rpc_templateset
+ */
+$templateset_default = 'default';
+$templateset_fallback = 'default';
+$rpc_templateset = 'default_rpc';
+
+$aTemplateSet[0]['ID'] = 'default';
+$aTemplateSet[0]['NAME'] = 'Default';
+$aTemplateSet[1]['ID'] = 'default_advanced';
+$aTemplateSet[1]['NAME'] = 'Advanced';
/**
* Default interface font size.
* '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
*/
$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
*
/**
* To install plugins, just add elements to this array that have
* the plugin directory name relative to the /plugins/ directory.
- * For instance, for the 'sqclock' plugin, you'd put a line like
+ * For instance, for the 'squirrelspell' plugin, you'd put a line like
* the following.
- * $plugins[] = 'sqclock';
- * $plugins[] = 'attachment_common';
+ * $plugins[] = 'squirrelspell';
+ * $plugins[] = 'listcommands';
*/
// Add list of enabled plugins here
+/**
+ * To disable all plugins regardless of any that are installed
+ * above, turn on $disable_plugins. To disable them ONLY for
+ * one user, put that username into $disable_plugins_user.
+ * @global boolean $disable_plugins
+ * @global string $disable_plugins_user
+ * @since 1.5.2
+ */
+$disable_plugins = false;
+$disable_plugins_user = '';
+
+
/*** Database ***/
/**
- * Read doc/database.txt in order to get more information
+ * Read the administrator's manual in order to get more information
* about these settings.
*/
/**
* Database-driven private addressbooks
* DSN (Data Source Name) for a database where the private
- * addressbooks are stored. See doc/db-backend.txt for more info.
+ * addressbooks are stored. See the administrator's manual for more info.
* If it is not set, the addressbooks are stored in files
* in the data dir.
* 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';
*/
$time_zone_type = 0;
+/**
+ * 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.
+ *
+ * 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 and 1.4.8
+ */
+$config_location_base = '';
+
/*** Tweaks ***/
/**
* Iframe sandbox code control
*/
$use_iframe = false;
-/**
- * Message Icons control
- *
- * Use icons for message and folder markers
- * @global bool $use_icons
- * @since 1.5.1
- */
-$use_icons = false;
-
/**
* PHP recode functions control
*
$use_php_iconv = false;
/**
+ * Output Buffering
+ *
+ * In some cases, buffering all output allows more complex functionality,
+ * especially for plugins that want to add headers on hooks that are beyond
+ * the point of output having been sent to the browser otherwise (although
+ * most plugins that need this feature will turn it on automatically by
+ * themselves).
+ *
+ * It is also possible to define a custom output handler as needed by special
+ * environments. If $buffered_output_handler is non-empty, a function named
+ * the same as the value of $buffered_output_handler should be defined in
+ * config_local.php.
+ *
+ */
+$buffer_output = false;
+$buffered_output_handler = '';
+
+/**
+ * Allow Remote configtest Access
+ *
* Controls remote configuration checks
* @global boolean $allow_remote_configtest
* @since 1.5.1
*/
$allow_remote_configtest = false;
+/**
+ * SquirrelMail Debug Mode
+ *
+ * Various debugging levels can be enabled using this setting.
+ * More than one mode can be used at once by combining them
+ * with pipes ("|"). See the SM_DEBUG_MODE_* constants in
+ * include/constants.php
+ */
+$sm_debug_mode = SM_DEBUG_MODE_OFF;
+
+/**
+ * "Secured Configuration" Mode
+ *
+ * Enable/disable "Secured Configuration" mode, wherein certain
+ * security-sensitive configuration settings are made immutable
+ * by other code.
+ */
+$secured_config = true;
+
+/**
+ * HTTPS Port
+ *
+ * This is the HTTPS (SSL-secured HTTP) port. It can be left empty,
+ * in which case SquirrelMail will assume the standard port 443.
+ * Make sure to set this correctly when serving HTTPS on a non-
+ * standard port.
+ */
+$sq_https_port = 443;
+
+/**
+ * Ignore HTTP_X_FORWARDED_* headers?
+ *
+ * Whether or not HTTP_X_FORWARDED_* headers are respected by
+ * SquirrelMail (or plugins).
+ */
+$sq_ignore_http_x_forwarded_headers = true;
+
/**
* Subscribe Listing Control
*
$config_use_color = 2;
/**
- * This option includes special configuration options
+ * Ask User for Personal Information on login
+ *
+ * When a user logs in that doesn't have an email address configured,
+ * redirect him/her to the options page with a request to fill in their
+ * personal information.
+ *
+ * @global bool $ask_user_info
*/
-@include SM_PATH . 'config/config_local.php';
+$ask_user_info = true;
-/**
- * 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.
- */
-?>
\ No newline at end of file