Source for file config_default.php
Documentation is available at config_default.php
* Default SquirrelMail configuration file
* BEFORE EDITING THIS FILE!
* Don't edit this file directly. Copy it to config.php before you
* edit it. However, it is best to use the configuration script
* conf.pl if at all possible. That is the easiest and cleanest way
* 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: config_default.php,v 1.150 2006/10/04 17:38:43 stevetruckstuff Exp $
/* Do not change this value. */
$config_version =
'1.5.0';
/*** Organization preferences ***/
* @global string $org_name
$org_name =
"SquirrelMail";
* Organization's logo picture (blank if none)
* @global string $org_logo
$org_logo =
SM_PATH .
'images/sm_logo.png';
* The width of the logo (0 for default)
* @global string $org_logo_width
* The height of the logo (0 for default)
* @global string $org_logo_height
$org_logo_height =
'111';
* This is the web page title that appears at the top of the browser window.
* @global string $org_title
$org_title =
"SquirrelMail";
* Rather than going to the signout.php page (which only allows you
* to sign back in), setting signout_page allows you to sign the user
* out and then redirect to whatever page you want. For instance,
* the following would return the user to your home page:
* Set to the empty string to continue to use the default signout page.
* @global string $signout_page
* By default SquirrelMail takes up the whole browser window,
* this allows you to embed it within sites using frames. Set
* this to the frame you want it to stay in.
* @global string $frame_top
* Here you can set name of the link displayed on the right side of main page.
* Link will be displayed only if you have $hide_sm_attributions
* @global string $provider_name
$provider_name =
'SquirrelMail';
* 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
* @global string $provider_uri
/*** Server Settings ***/
* The domain part of local email addresses.
* This is for all messages sent out from this server.
* Reply address is generated by $username@$domain
* If you are running on a machine that doesn't have the tm_gmtoff
* value in your time structure and if you are in a time zone that
* has a negative offset, you need to set this value to 1. This is
* typically people in the US that are running Solaris 7.
* @global bool $invert_time
* What should be used when sending email.
* If it is set to false, SquirrelMail will use SMTP server settings.
* If it is set to true, SquirrelMail will use program defined in
* @global bool $useSendmail
* Your SMTP server (usually the same as the IMAP server).
* @global string $smtpServerAddress
$smtpServerAddress =
'localhost';
* Your SMTP port number (usually 25).
* @global integer $smtpPort
* 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.
* 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.
* Encoded information can be decoded with decrypt_headers.php script
* from SquirrelMail contrib/ directory.
* @global string $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). 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
$sendmail_args =
'-i -t';
* The dns name (or IP address) for your imap server.
* @global string $imapServerAddress
$imapServerAddress =
'localhost';
* Port used by your imap server. (Usually 143)
* @global integer $imapPort
* The type of IMAP server you are running.
* Valid type are the following (case is important):
* Please note that this changes only some of server settings.
* In order to set everything correctly, you need to adjust several
* SquirrelMail options. These options are listed in doc/presets.txt
* @global string $imap_server_type
$imap_server_type =
'other';
* Secure IMAP connection controls
* 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
* Secure SMTP connection controls
* 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
* SMTP authentication mechanism
* auth_mech can be either 'none', 'login','plain', 'cram-md5', or 'digest-md5'
* @global string $smtp_auth_mech
$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
$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
$smtp_sitewide_pass =
'';
* IMAP authentication mechanism
* auth_mech can be either 'login','plain', 'cram-md5', or 'digest-md5'
* @global string $imap_auth_mech
$imap_auth_mech =
'login';
* This is the delimiter that your IMAP server uses to distinguish between
* folders. For example, Cyrus uses '.' as the delimiter and a complete
* folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would
* look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'
* but if you are sure you know what delimiter your server uses, you can
* To have it autodetect the delimiter, set it to 'detect'.
* @global string $optional_delimiter
$optional_delimiter =
'detect';
* POP before SMTP setting
* Do you wish to use POP3 before SMTP? Your server must
* support this in order for SquirrelMail to work with it.
* @global bool $pop_before_smtp
$pop_before_smtp =
false;
/*** Folder Settings ***/
* Default IMAP folder prefix
* Many servers store mail in your home directory. With this, they
* store them in a subdirectory: mail/ or Mail/, etc. If your server
* does this, please set this to what the default mail folder should
* be. This is still a user preference, so they can change it if it
* is different for each user.
* $default_folder_prefix = 'mail/';
* $default_folder_prefix = 'Mail/folders/';
* If you do not use this, set it to the empty string.
* @global string $default_folder_prefix
$default_folder_prefix =
'';
* User level prefix control
* If you do not wish to give them the option to change this, set it
* to false. Otherwise, if it is true, they can change the folder prefix
* @global bool $show_prefix_option
$show_prefix_option =
false;
* The following are related to deleting messages.
* If this is set to 'true', when 'delete' is pressed, it
* will attempt to move the selected messages to the folder
* named $trash_folder. If it's set to 'false', we won't even
* attempt to move the messages, just delete them.
* If this is set to 'true', sent messages will be stored in
* $sent_folder by default.
* If this is set to 'true', users are able to use $draft_folder
* to store their unfinished messages.
* This is the path to the default trash folder. For Cyrus
* IMAP, it would be 'INBOX.Trash', but for UW it would be
* 'Trash'. We need the full path name here.
* This is the patch to where Draft messages will be stored.
* If this is true, when a message is moved or copied, the
* source mailbox will get expunged, removing all messages
* This is the path to where Sent messages will be stored.
* If this is true, when a folder is deleted then it will
* not get moved into the Trash folder.
* @global bool $default_move_to_trash
* @global bool $default_move_to_sent
* @global bool $default_save_as_draft
* @global string $trash_folder
* @global string $sent_folder
* @global string $draft_folder
* @global bool $auto_expunge
* @global bool $delete_folder
$default_move_to_trash =
true;
$default_move_to_sent =
true;
$default_save_as_draft =
true;
$trash_folder =
'INBOX.Trash';
$sent_folder =
'INBOX.Sent';
$draft_folder =
'INBOX.Drafts';
* Special Folder Color Control
* Whether or not to use a special color for special folders. If not,
* special folders will be the same color as the other folders.
* @global bool $use_special_folder_color
$use_special_folder_color =
true;
* Create Special Folders Control
* Should I create the Sent and Trash folders automatically for
* a new user that doesn't already have them created?
* @global bool $auto_create_special
$auto_create_special =
true;
* List Special Folders First Control
* Whether or not to list the special folders first (true/false).
* @global bool $list_special_folders_first
$list_special_folders_first =
true;
* Subfolder Layout Control
* Are all your folders subfolders of INBOX (i.e. cyrus IMAP server).
* If you are unsure, set it to false.
* @global bool $default_sub_of_inbox
$default_sub_of_inbox =
true;
* Subfolder Format Control
* Some IMAP daemons (UW) handle folders weird. They only allow a
* folder to contain either messages or other folders, not both at
* the same time. This option controls whether or not to display an
* option during folder creation. The option toggles which type of
* If this option confuses you, just set it to 'true'. You can not hurt
* anything if it's true, but some servers will respond weird if it's
* false. (Cyrus works fine whether it's true OR false).
* @global bool $show_contain_subfolders_option
$show_contain_subfolders_option =
false;
* These next two options set the defaults for the way that the
* users see their folder list.
* Specifies whether or not the users will see the number of
* unseen in each folder by default and also which folders to
* do this to. Valid values are: 1=none, 2=inbox, 3=all.
* Specifies the type of notification to give the users by
* default. Valid choice are: 1=(4), 2=(4,25).
* @global integer $default_unseen_notify
* @global integer $default_unseen_type
$default_unseen_notify =
2;
$default_unseen_type =
1;
* This enables the no select fix for Cyrus when subfolders
* exist but parent folders do not
* @global bool $noselect_fix_enable
$noselect_fix_enable =
false;
/*** General options ***/
* 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).
* The path name can be absolute or relative (to the config directory).
* If path is relative, it must use SM_PATH constant.
* $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 =
'/var/local/squirrelmail/data/';
* Path to directory used for storing attachments while a mail is
* being sent. There are a few security considerations regarding
* + It should have the permission 733 (rwx-wx-wx) to make it
* impossible for a random person with access to the webserver to
* list files in this directory. Confidential data might be laying
* + 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. You should have some script that deletes
* + It should probably be another directory than data_dir.
* @global string $attachment_dir
$attachment_dir =
'/var/local/squirrelmail/attach/';
* Hash level used for data directory.
* This option allows spliting file based SquirrelMail user
* data storage directory into several subfolders. Number from
* 0 to 4 allows allows having up to four subfolder levels.
* Hashing should speed up directory access if you have big number
* of users (500 and more).
* @global integer $dir_hash_level
* Default Size of Folder List
* This is the default size of the folder list. Default
* is 150, but you can set it to whatever you wish.
* @global string $default_left_size
$default_left_size =
'150';
* Some IMAP servers allow a username (like 'bob') to log in if they use
* uppercase in their name (like 'Bob' or 'BOB'). This creates extra
* preference files. Toggling this option to true will transparently
* change all usernames to lowercase.
* @global bool $force_username_lowercase
$force_username_lowercase =
false;
* This option enables use of email priority flags by end users.
* @global bool $default_use_priority
$default_use_priority =
true;
* SquirrelMail Attributions Control
* This option disables display of "created by SquirrelMail developers"
* strings and provider link
* @global bool $hide_sm_attributions
$hide_sm_attributions =
false;
* Delivery Receipts Control
* This option enables use of read/delivery receipts by end users.
* @global bool $default_use_mdn
* If you don't want to allow users to change their email address
* then you can set $edit_identity to false, if you want them to
* not be able to change their full name too then set $edit_name
* to false as well. $edit_name has no effect unless $edit_identity
* @global bool $edit_identity
* @global bool $edit_name
* 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
* 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
$hide_auth_header =
false;
* Server Side Threading Control
* 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
$disable_thread_sort =
false;
* Server Side Sorting Control
* 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
$disable_server_sort =
false;
* IMAP Charset Use Control
* This option allows you to choose if SM uses charset search
* Your imap server should support SEARCH CHARSET command for
* @global bool $allow_charset_search
$allow_charset_search =
true;
* Search functions control
* This option allows you to control the use of advanced search form.
* Set to 0 to enable basic search only, 1 to enable advanced search only
* @global integer $allow_advanced_search
$allow_advanced_search =
0;
* Leave this alone unless you know what you are doing.
* @global string $session_name
$session_name =
'SQMSESSID';
* 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
* 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.
* $user_theme_default sets theme that will be used by default
* @global integer $user_theme_default
* Listing of installed themes
* @global array $user_themes
$user_themes[0]['PATH'] =
'none';
$user_themes[0]['NAME'] =
'Default';
$user_themes[1]['PATH'] =
'../css/blue_gradient/';
$user_themes[1]['NAME'] =
'Blue Options';
* Use icons for message and folder markers
* @global bool $use_icons
* 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.
* @global integer $icon_theme_def
* Listing of installed icon themes
* @global array $icon_themes;
$icon_themes[0]['PATH'] =
'none';
$icon_themes[0]['NAME'] =
'No Icons';
$icon_themes[1]['PATH'] =
'template';
$icon_themes[1]['NAME'] =
'Template Default Icons';
$icon_themes[2]['PATH'] =
'../images/themes/default/';
$icon_themes[2]['NAME'] =
'Default Icon Set';
$icon_themes[3]['PATH'] =
'../images/themes/xp/';
$icon_themes[3]['NAME'] =
'XP Style Icons';
* You can define your own template 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.
* @global integer $templateset_default
$templateset_default =
0;
$templateset_fallback =
0;
$aTemplateSet[0]['ID'] =
'default';
$aTemplateSet[0]['NAME'] =
'Default';
$aTemplateSet[1]['ID'] =
'default_advanced';
$aTemplateSet[1]['NAME'] =
'Advanced';
* Default interface font size.
* @global string $default_fontsize
* @global string $default_fontset
* List of available fontsets.
* @global array $fontsets
$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';
* Array of arrays with LDAP server parameters. See
* functions/abook_ldap_server.php for a list of possible
* $ldap_server[0] = Array(
* 'host' => 'memberdir.netscape.com',
* 'name' => 'Netcenter Member Directory',
* 'base' => 'ou=member_directory,o=netcenter.com'
* NOTE: please see security note at the top of this file when
// Add your ldap server options here
* Javascript in Addressbook Control
* Users may search their addressbook via either a plain HTML or Javascript
* enhanced user interface. This option allows you to set the default choice.
* Set this default choice as either:
* @global bool $default_use_javascript_addr_book
$default_use_javascript_addr_book =
false;
* Shared filebased address book
* @global string $abook_global_file
* Writing into shared address book control
* @global bool $abook_global_file_writeable
$abook_global_file_writeable =
false;
* Listing of shared address book control
* @global bool $abook_global_file_listing
$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
* @global integer $abook_file_line_length
$abook_file_line_length =
2048;
* This is a message that is displayed immediately after a user logs in.
* 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
* $plugins[] = 'sqclock';
* $plugins[] = 'attachment_common';
// Add list of enabled plugins here
* Read doc/database.txt in order to get more information
* 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.
* If it is not set, the addressbooks are stored in files
* The DSN is in the format: mysql://user:pass@hostname/dbname
* The table is the name of the table to use within the
* NOTE: please see security note at the top of this file when
$addrbook_table =
'address';
* Database used to store user data
$prefs_table =
'userprefs';
* @global string $prefs_key_field
$prefs_key_field =
'prefkey';
* Size of preference key field
* @global integer $prefs_key_size
* @global string $prefs_user_field
$prefs_user_field =
'user';
* Size of preference owner field
* @global integer $prefs_user_size
* @global string $prefs_val_field
$prefs_val_field =
'prefval';
* Size of preference key field
* @global integer $prefs_val_size
/*** Global sql database options ***/
* DSN of global address book database
* @global string $addrbook_global_dsn
$addrbook_global_dsn =
'';
* Table used for global database address book
* @global string $addrbook_global_table
$addrbook_global_table =
'global_abook';
* Control writing into global database address book
* @global boolean $addrbook_global_writeable
$addrbook_global_writeable =
false;
* Control listing of global database address book
* @global boolean $addrbook_global_listing
$addrbook_global_listing =
false;
/*** Language settings ***/
* This is the default language. It is used as a last resort
* if SquirrelMail can't figure out which language to display.
* Language names usually consist of language code, undercore
* symbol and country code
* @global string $squirrelmail_default_language
$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 translation settings.
* @global string $default_charset
$default_charset =
'iso-8859-1';
* Alternative Language Names Control
* This options allows displaying native language names in language
* @global bool $show_alternative_names
$show_alternative_names =
false;
* Aggressive Decoding Control
* This option enables reading of Eastern multibyte encodings.
* Functions that provide this support are very cpu and memory intensive.
* Don't enable this option unless you really need it.
* @global bool $aggressive_decoding
$aggressive_decoding =
false;
* This option allows charset conversions when output charset does not support
* all symbols used in original charset. Symbols unsupported by output charset
* will be replaced with question marks.
* @global bool $lossy_encoding
* Controls use of time zone libraries
* <li>0 - default, SquirrelMail uses GNU C timezone names in
* TZ environment variables
* <li>1 - strict, SquirrelMail uses 'TZ' subkey values in TZ
* <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
* Use of any other value switches to default SquirrelMail time zone
* handling ($time_zone_type).
* @global integer $time_zone_type
* 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.
* 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
$config_location_base =
'';
* Iframe sandbox code control
* Use iframe to render html emails
* (temp option used during debuging of new code)
* @global bool $use_iframe
* PHP recode functions control
* Use experimental code with php recode functions when reading messages with
* different encoding. This code is faster that original SM functions,
* but it require php with recode support.
* Don't enable this option if you are not sure about availability of
* @global bool $use_php_recode
* PHP iconv functions control
* Use experimental code with php iconv functions when reading messages with
* different encoding. This code is faster that original SM functions,
* but it require php with iconv support and works only with some translations.
* Don't enable this option if you are not sure about availability of
* @global bool $use_php_iconv
* Controls remote configuration checks
* @global boolean $allow_remote_configtest
$allow_remote_configtest =
false;
* Subscribe Listing Control
* this disables listing all of the folders on the IMAP Server to
* generate the folder subscribe listbox (this can take a long time
* when you have a lot of folders). Instead, a textbox will be
* displayed allowing users to enter a specific folder name to subscribe to
* This option can't be changed by conf.pl
* @global bool $no_list_for_subscribe
$no_list_for_subscribe =
false;
* Color in config control
* This option is used only by conf.pl script to generate configuration
* menu with some colors and is provided here only as reference.
* @global integer $config_use_color
Documentation generated on Sat, 07 Oct 2006 16:10:07 +0300 by phpDocumentor 1.3.0RC6