<?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
* to configure.
+ *
+ * @package squirrelmail
+ * @subpackage config
*/
/* Do not change this value. */
/*** Organization preferences ***/
/**
* Organization's name
+ * @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
*/
$org_logo_width = '308';
/**
* The height of the logo (0 for default)
+ * @global string $org_logo_height
*/
$org_logo_height = '111';
/**
* Webmail Title
- * This is the web page title that appears at the top of the browser window.
+ *
+ * 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
+ *
* 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:
* $signout_page = '/';
* Set to the empty string to continue to use the default signout page.
+ * @global string $signout_page
*/
$signout_page = '';
/**
+ * Top frame
+ *
* 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
*/
$frame_top = '_top';
/**
- * Here you can set link displayed on the right side of main page.
- * $provider_name sets name of link
- * $provider_url set address used in the link
+ * Provider name
*
- * Link will be displayed only if you have $hide_sm_attributions
+ * 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
* option set to true.
+ * @global string $provider_name
*/
$provider_name = 'SquirrelMail';
-$provider_uri = 'http://www.squirrelmail.org/';
+/**
+ * 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 = '';
/*** Server Settings ***/
/**
+ * Default Domain
+ *
* The domain part of local email addresses.
* This is for all messages sent out from this server.
* Reply address is generated by $username@$domain
- * Example: In bob@foo.com, foo.com is the domain.
+ * Example: In bob@example.com, example.com is the domain.
+ * @global string $domain
*/
$domain = 'example.com';
/**
+ * Time offset inversion
+ *
* 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
*/
$invert_time = false;
/**
+ * Default send transport
+ *
* 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
+ * If it is set to true, SquirrelMail will use program defined in
* $sendmail_path
+ * @global bool $useSendmail
*/
$useSendmail = false;
/**
- * Your SMTP server and port number (usually the same as the IMAP server).
+ * Your SMTP server (usually the same as the IMAP server).
+ * @global string $smtpServerAddress
*/
$smtpServerAddress = 'localhost';
+/**
+ * Your SMTP port number (usually 25).
+ * @global integer $smtpPort
+ */
$smtpPort = 25;
/**
+ * 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
+ * @since 1.5.1 and 1.4.5
+ */
+$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
+ * this program will follow options used by original sendmail
* (http://www.sendmail.org).
+ * @global string $sendmail_path
*/
$sendmail_path = '/usr/sbin/sendmail';
-
+
/**
- * The dns name (or IP address) and port for your imap server.
+ * IMAP server address
+ *
+ * The dns name (or IP address) for your imap server.
+ * @global string $imapServerAddress
*/
$imapServerAddress = 'localhost';
+
+/**
+ * IMAP server port
+ *
+ * Port used by your imap server. (Usually 143)
+ * @global integer $imapPort
+ */
$imapPort = 143;
/**
+ * IMAP server type
+ *
* The type of IMAP server you are running.
* Valid type are the following (case is important):
* courier
* exchange
* uw
* macosx
+ * hmailserver
* mercury32
+ * dovecot
* other
*
* 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
+ * SquirrelMail options. These options are listed in doc/presets.txt
+ * @global string $imap_server_type
*/
$imap_server_type = 'other';
/**
- * Advanced authentication options
+ * Advanced IMAP authentication options control
+ *
* 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
*/
$use_imap_tls = false;
+
+/**
+ * Advanced SMTP authentication options control
+ *
+ * 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
+ */
$use_smtp_tls = false;
/**
- * auth_mech can be either 'login','plain', 'cram-md5', or 'digest-md5'
- * SMTP can also be 'none'
+ * 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';
+
+/**
+ * IMAP authentication mechanism
+ *
+ * auth_mech can be either 'login','plain', 'cram-md5', or 'digest-md5'
+ * @global string $imap_auth_mech
+ */
$imap_auth_mech = 'login';
/**
+ * IMAP folder delimiter
+ *
* 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
* specify it here.
*
* 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
* $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
* to be anything.
+ * @global bool $show_prefix_option
*/
$show_prefix_option = false;
* $delete_folder
* 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;
$delete_folder = false;
/**
+ * 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;
-/* Whether or not to list the special folders first (true/false). */
+/**
+ * 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
* folder it should be.
*
- * If this option confuses you, just set it to 'true'. You can not hurt
+ * 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.
* $default_unseen_notify
- * Specifies whether or not the users will see the number of
+ * 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.
* $default_unseen_type
* 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;
/**
+ * NoSelect Fix Control
+ *
* 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
+ *
* 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
*
* Relative (to main SM directory):
* $data_dir = SM_PATH . 'data/';
+ * @global string $data_dir
*/
$data_dir = SM_PATH . 'data/';
/**
+ * Attachments directory
+ *
* Path to directory used for storing attachments while a mail is
* being sent. There are a few security considerations regarding
* this 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
+ * is also impossible for the webserver to delete files lying around
* there for too long.
* + It should probably be another directory than data_dir.
+ * @global string $attachment_dir
*/
$attachment_dir = $data_dir;
/**
* Hash level used for data directory.
- *
- * This option allows spliting file based squirrelmail user
+ *
+ * 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
+ * Hashing should speed up directory access if you have big number
* of users (500 and more).
+ * @global integer $dir_hash_level
*/
$dir_hash_level = 0;
/**
+ * 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';
/**
+ * Username Case Control
+ *
* 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;
/**
+ * Email Priority Control
+ *
* This option enables use of email priority flags by end users.
+ * @global bool $default_use_priority
*/
$default_use_priority = true;
/**
- * This option disables display of "created by squirrelmail developers"
+ * 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;
/**
- * This option enables use of read/delivery reciepts by end users.
+ * Delivery Receipts Control
+ *
+ * This option enables use of read/delivery receipts by end users.
+ * @global bool $default_use_mdn
*/
$default_use_mdn = true;
/**
+ * Identity Controls
+ *
* 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
* is false;
+ * @global bool $edit_identity
+ * @global bool $edit_name
*/
$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
+ * Your IMAP server must support the THREAD extension for
* this to work.
+ * @global bool $allow_thread_sort
*/
$allow_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
*/
$allow_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
+ * Your imap server should support SEARCH CHARSET command for
* this to work.
+ * @global bool $allow_charset_search
*/
$allow_charset_search = true;
/**
- * PHP session name. Leave this alone unless you know what you are doing.
+ * 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
+ * or 2 to enable both.
+ * @global integer $allow_advanced_search
+ */
+$allow_advanced_search = 0;
+
+/**
+ * PHP session name.
+ *
+ * Leave this alone unless you know what you are doing.
+ * @global string $session_name
*/
$session_name = 'SQMSESSID';
*
* 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
+ * $theme_css sets stylesheet (from theme/css directory) that will be
* used by default.
+ * @global integer $theme_default
+ * @global string $theme_css
*/
$theme_default = 0;
$theme_css = '';
+/**
+ * Listing of installed themes
+ * @global array $theme
+ */
$theme[0]['PATH'] = SM_PATH . 'themes/default_theme.php';
$theme[0]['NAME'] = 'Default';
$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';
/**
* LDAP server(s)
* 'host' => 'memberdir.netscape.com',
* 'name' => 'Netcenter Member Directory',
* 'base' => 'ou=member_directory,o=netcenter.com'
- * );
+ * );
*/
// 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:
* true = javascript
* false = html
+ * @global bool $default_use_javascript_addr_book
*/
$default_use_javascript_addr_book = false;
+/**
+ * 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
- * This is a message that is displayed immediately after a user logs in.
+ *
+ * This is a message that is displayed immediately after a user logs in.
+ * @global string $motd
*/
$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
/*** Database ***/
/**
- * Read doc/database.txt in order to get more information
+ * Read doc/database.txt in order to get more information
* about these settings.
*/
/**
$prefs_key_field = 'prefkey';
$prefs_user_field = 'user';
$prefs_val_field = 'prefval';
+
+/*** Global sql database options ***/
/**
- * Global sql database options
+ * DSN of global address book database
+ * @global string $addrbook_global_dsn
+ * @since 1.5.1
*/
$addrbook_global_dsn = '';
+/**
+ * Table used for global database address book
+ * @global string $addrbook_global_table
+ * @since 1.5.1
+ */
$addrbook_global_table = 'global_abook';
+/**
+ * Control writing into global database address book
+ * @global boolean $addrbook_global_writeable
+ * @since 1.5.1
+ */
$addrbook_global_writeable = false;
+/**
+ * Control listing of global database address book
+ * @global boolean $addrbook_global_listing
+ * @since 1.5.1
+ */
$addrbook_global_listing = false;
/*** Language settings ***/
/**
* Default language
+ *
* 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
+ * 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. Do not set this to US-ASCII,
- * use ISO-8859-1 instead.
- *
- * You can set this option, only if $squirrelmail_default_language setting
- * contains 'en_US' string. In any other case system does not allow
- * making mistakes with incorrect language and charset combinations.
+ * Default Charset
+ *
+ * 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.
+ *
+ * @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';
/**
- * This options allows displaying native language names in language
+ * Alternative Language Names Control
+ *
+ * This options allows displaying native language names in language
* selection box.
+ * @global bool $show_alternative_names
+ * @since 1.5.0
*/
$show_alternative_names = false;
/**
- * This option enables reading of Eastern multibyte encodings.
+ * 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
+ * @since 1.5.1
+ */
+$aggressive_decoding = false;
+
+/**
+ * Lossy Encoding Control
+ *
+ * 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
+ * @since 1.5.1
*/
-$agresive_decoding = false;
+$lossy_encoding = false;
/*** Tweaks ***/
/**
+ * Advanced DHTML tree control
+ *
* Use experimental DHTML folder listing
+ * @global bool $advanced_tree
+ * @since 1.5.0
*/
$advanced_tree = false;
+
+/**
+ * Iframe sandbox code control
+ *
+ * Use iframe to render html emails
+ * (temp option used during debuging of new code)
+ * @global bool $use_iframe
+ * @since 1.5.1
+ */
+$use_iframe = false;
+
/**
- * Use older way of folder listing
+ * Message Icons control
+ *
+ * Use icons for message and folder markers
+ * @global bool $use_icons
+ * @since 1.5.1
*/
-$oldway = false;
+$use_icons = false;
+
/**
+ * 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
+ *
+ * Don't enable this option if you are not sure about availability of
* recode support.
+ * @global bool $use_php_recode
+ * @since 1.5.0
*/
$use_php_recode = false;
+
/**
+ * 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
+ *
+ * Don't enable this option if you are not sure about availability of
* iconv support.
+ * @global bool $use_php_iconv
+ * @since 1.5.0
*/
$use_php_iconv = false;
/**
+ * Controls remote configuration checks
+ * @global boolean $allow_remote_configtest
+ * @since 1.5.1
+ */
+$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.
+ * menu with some colors and is provided here only as reference.
+ * @global integer $config_use_color
*/
$config_use_color = 2;
projects / squirrelmail.git / blobdiff