Testing CVS access
[squirrelmail.git] / config / config_default.php
index c8a1aa4b8a7c93525b8e2c2daf08f23a194bece4..e7d688783edddc28aeee5b4a13989eb72c69c67b 100644 (file)
@@ -1,15 +1,45 @@
-<?
+<?php
+//
+//  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.
+//
+
+    // This makes sure we don't load it dozens of times
+    // don't change this
+    if (defined('config_php'))
+       return;
+    define('config_php', true);
+
+    // don't change
+    global $config_version;
+    $config_version = "x63";
+
 //  Organization's logo picture (blank if none)
+    global $org_logo;
     $org_logo = "../images/sm_logo.jpg";
 
 //  Organization's name
+    global $org_name;
     $org_name = "SquirrelMail";
 
 //  Webmail Title
 //  This is the title that goes at the top of the browser window
+    global $org_title;
     $org_title = "SquirrelMail $version";
+    
+//  Default language
+//  This is the default language.  It is used as a last resort if SquirrelMail
+//  can't figure out which language to display.
+//  Use the two-letter code.
+    global $squirrelmail_default_language;
+    $squirrelmail_default_language = "en";
 
 //  The server that your imap server is on
+    global $imapServerAddress, $imapPort;
     $imapServerAddress = "localhost";
     $imapPort = 143;
 
 //   Example:  in "luke@usa.om.org", usa.om.org is the domain.
 //             this is for all the messages sent out.  Reply address
 //             is generated by $username@$domain
+    global $domain;
     $domain = "mydomain.com";
 
 //  Your SMTP server and port number (usually the same as the IMAP server)
+    global $smtpServerAddress, $smtpPort;
     $smtpServerAddress = "localhost";
     $smtpPort = 25;
 
 //  Uncomment this if you want to deliver locally using sendmail instead
 //  of connecting to a SMTP-server
+//    global $useSendmail, $sendmail_path;
 //    $useSendmail = true;
 //    $sendmail_path = "/usr/sbin/sendmail";
 
 //  This is displayed right after they log in
-    $motd = "You are using SquirrelMail's web-based email client.  If you run into any bugs or have suggestions, please report them to our <A HREF=\"mailto:squirrelmail-list@sourceforge.net\">mailing list</A>";
-
-//  Themes
-//     You can define your own theme and put it in this directory.  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.
-//
-//     You can download themes from http://squirrelmail.sourceforge.net/index.php3?page=10
-//
-//  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.
-
-    // The first one HAS to be here, and is your system's default theme.
-    // It can be any theme you want
-    $theme[0]["PATH"] = "../config/default_theme.php";
-    $theme[0]["NAME"] = "Default";
-
-    $theme[1]["PATH"] = "../config/sandstorm_theme.php";
-    $theme[1]["NAME"] = "Sand Storm";
-
-    $theme[2]["PATH"] = "../config/deepocean_theme.php";
-    $theme[2]["NAME"] = "Deep Ocean";
-
-    $theme[3]["PATH"] = "../config/slashdot_theme.php";
-    $theme[3]["NAME"] = "Slashdot";
-
-    $theme[4]["PATH"] = "../config/purple_theme.php";
-    $theme[4]["NAME"] = "Purple";
-
-    $theme[5]["PATH"] = "../config/forest_theme.php";
-    $theme[5]["NAME"] = "Forest";
-
-    $theme[6]["PATH"] = "../config/ice_theme.php";
-    $theme[6]["NAME"] = "Ice";
+   global $motd;
+   $motd = "";
 
 //  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 $use_special_folder_color;
     $use_special_folder_color = true;
 
-/* The following are related to deleting messages.
- *   $move_to_trash
- *         - 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.
- *   $trash_folder
- *         - 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.
- *   $auto_expunge
- *         - If this is true, when a message is moved or copied, the source mailbox
- *           will get expunged, removing all messages marked "Deleted".
- */
+//  The type of IMAP server you are running
+//  Valid type are the following (case is important).
+//  
+//  courier
+//  cyrus
+//  exchange
+//  uw
+//  other
+    global $imap_server_type;
+    $imap_server_type = "cyrus";
+
+// 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 $signout_page;
+    $signout_page = "";
+
+//  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.
+//
+//  Example:
+//     $default_folder_prefix = "mail/";
+//        -- or --
+//     $default_folder_prefix = "Mail/folders/";
+//
+//  If you do not use this, please set it to "".
+    global $default_folder_prefix;
+    $default_folder_prefix = "";
+//  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 $show_prefix_option;
+    $show_prefix_option = false;
+
+//  The following are related to deleting messages.
+//    $move_to_trash
+//         - 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.
+//    $trash_folder
+//         - 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.
+//    $auto_expunge
+//         - If this is true, when a message is moved or copied, the
+//           source mailbox will get expunged, removing all messages
+//           marked "Deleted".
+//    $sent_folder
+//         - This is the path to where Sent messages will be stored.
 
+    global $default_move_to_trash, $default_move_to_sent, $trash_folder,
+        $auto_expunge, $sent_folder;
     $default_move_to_trash = true;
+    $default_move_to_sent  = true;
     $trash_folder = "INBOX.Trash";
     $auto_expunge = true;
+    $sent_folder = "INBOX.Sent";
 
-//  Special Folders are folders that can't be manipulated like normal user created
-//  folders can.  A couple of examples would be "INBOX.Trash", "INBOX.Drafts".  We have
-//  them set to Netscape's default mailboxes, but this obviously can be changed.
-//  To add one, just add a new number to the array.
+//  Special Folders are folders that can't be manipulated like normal
+//  user created folders can. A couple of examples would be
+//  "INBOX.Trash", "INBOX.Drafts". We have them set to Netscape's
+//  default mailboxes, but this obviously can be changed. To add one,
+//  just add a new number to the array.
 
+    global $special_folders;
     $special_folders[0] = "INBOX";   // The first one has to be the inbox (whatever the name is)
     $special_folders[1] = $trash_folder;
-    $special_folders[2] = "INBOX.Sent";
+    $special_folders[2] = $sent_folder;
     $special_folders[3] = "INBOX.Drafts";
     $special_folders[4] = "INBOX.Templates";
 
+//  Should I create the Sent and Trash folders automatically for a new
+//  user that doesn't already have them created?
+    global $auto_create_special;
+    $auto_create_special = true;
+
 //  Whether or not to list the special folders first  (true/false)
+    global $list_special_folders_first;
     $list_special_folders_first = true;
 
 //  Are all your folders subfolders of INBOX (i.e.  cyrus IMAP server)
 //  If you are not sure, set it to false.
+    global $default_sub_of_inbox;
     $default_sub_of_inbox = true;
 
-//  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.
+//  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, make it "true".  You can't 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).
+//  If this option confuses you, make it "true". You can't 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 $show_contain_subfolders_option;
     $show_contain_subfolders_option = false;
 
-//  Whether or not to use META tags and automatically forward after an action has
-//  been completed.
-    $auto_forward = true;
+//  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. For cyrillic it is best to use KOI8-R,
+//  since this implementation is faster than the alternatives.
+    global $default_charset;
+    $default_charset = "iso-8859-1";
 
 //  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 anywhere you would like.   The path name can be absolute or
-//    relative (to the config directory).  It doesn't matter.  Here are two examples:
+//    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:
 //
 //  Absolute:
 //    $data_dir = "/usr/local/squirrelmail/data/";
 //
 //  Relative (to the config directory):
 //    $data_dir = "../data/";
-
+    global $data_dir;
     $data_dir = "../data/";
-?>
+
+//  Path to directory used for storing attachments while a mail is
+//  being sent. There are a few security considerations regarding this
+//  directory:
+//    - 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
+//      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.
+//    - It should probably be another directory than data_dir.
+    global $attachment_dir;
+    $attachment_dir = $data_dir;
+
+//  This is the default size of the folder list.  Default is 150,
+//  but you can set it to whatever you wish.
+   global $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 $force_username_lowercase;
+   $force_username_lowercase = false;
+
+
+//  Themes
+//     You can define your own theme and put it in this directory.  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.
+//
+//  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.
+    global $theme;
+
+    // The first one HAS to be here, and is your system's default theme.
+    // It can be any theme you want
+    $theme[0]["PATH"] = "../themes/default_theme.php";
+    $theme[0]["NAME"] = "Default";
+
+    $theme[1]["PATH"] = "../themes/plain_blue_theme.php";
+    $theme[1]["NAME"] = "Plain Blue";
+
+    $theme[2]["PATH"] = "../themes/sandstorm_theme.php";
+    $theme[2]["NAME"] = "Sand Storm";
+
+    $theme[3]["PATH"] = "../themes/deepocean_theme.php";
+    $theme[3]["NAME"] = "Deep Ocean";
+
+    $theme[4]["PATH"] = "../themes/slashdot_theme.php";
+    $theme[4]["NAME"] = "Slashdot";
+
+    $theme[5]["PATH"] = "../themes/purple_theme.php";
+    $theme[5]["NAME"] = "Purple";
+
+    $theme[6]["PATH"] = "../themes/forest_theme.php";
+    $theme[6]["NAME"] = "Forest";
+
+    $theme[7]["PATH"] = "../themes/ice_theme.php";
+    $theme[7]["NAME"] = "Ice";
+
+    $theme[8]["PATH"] = "../themes/seaspray_theme.php";
+    $theme[8]["NAME"] = "Sea Spray";
+
+    $theme[9]["PATH"] = "../themes/bluesteel_theme.php";
+    $theme[9]["NAME"] = "Blue Steel";
+
+    $theme[10]["PATH"] = "../themes/dark_grey_theme.php";
+    $theme[10]["NAME"] = "Dark Grey";
+
+    $theme[11]["PATH"] = "../themes/high_contrast_theme.php";
+    $theme[11]["NAME"] = "High Contrast";
+
+    $theme[12]["PATH"] = "../themes/black_bean_burrito_theme.php";
+    $theme[12]["NAME"] = "Black Bean Burrito";
+
+    $theme[13]["PATH"] = "../themes/servery_theme.php";
+    $theme[13]["NAME"] = "Servery";
+
+    $theme[14]["PATH"] = "../themes/maize_theme.php";
+    $theme[14]["NAME"] = "Maize";
+
+    $theme[15]["PATH"] = "../themes/bluesnews_theme.php";
+    $theme[15]["NAME"] = "BluesNews";
+    
+    $theme[16]["PATH"] = "../themes/deepocean2_theme.php";
+    $theme[16]["NAME"] = "Deep Ocean 2";
+
+    $theme[17]["PATH"] = "../themes/blue_gray_theme.php";
+    $theme[17]["NAME"] = "Blue Gray";
+
+//  LDAP server(s)
+//
+//    Array of arrays with LDAP server parameters. See
+//    functions/abook_ldap_server.php for a list of possible
+//    parameters
+//
+global $ldap_server;
+//
+//    EXAMPLE:
+//
+//    $ldap_server[0] = Array(
+//                     "host" => "memberdir.netscape.com",
+//                     "name" => "Netcenter Member Directory",
+//                     "base" => "ou=member_directory,o=netcenter.com");
+
+//  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 defined, the addressbooks are stored in files
+//    in the data dir.
+//
+//      global $addrbook_dsn;
+//     $addrbook_dsn = 'mysql://user:pass@hostname/dbname';
+
+
+ // you have an option to chose between javascript or html version of
+ // address book searching.  
+ //   true = javascript
+ //  false = html
+ global $default_use_javascript_addr_book;
+ $default_use_javascript_addr_book = 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 unseen in each folder by default
+ //                            and alsy which folders to do this to.
+ //                            1=none, 2=inbox, 3=all
+ //   $default_unseen_type     specifies the type of notification to give the
+ //                            users by default.
+ //                            1=(4), 2=(4,25)
+ global $default_unseen_notify, $default_unseen_type;
+ $default_unseen_notify = 2;
+ $default_unseen_type   = 1;
+ // 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 $invert_time;
+ $invert_time = false;
+
+ global $plugins;
+ // 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
+ // the following:
+ //   $plugins[0] = "sqclock";
+ //   $plugins[1] = "attachment_common";
+
+// Do not add the closing PHP tag here just because we want to avoid
+// the potential for parsing errors if there is a newline added