Found this stuff when trying to figure out why I couldn't name a folder
[squirrelmail.git] / config / config_default.php
CommitLineData
59177427 1<?php
390372b4 2//
3// BEFORE EDITING THIS FILE!
4//
5// Don't edit this file directly. Copy it to config.php before you
6// edit it. However, it is best to use the configuration script
7// conf.pl if at all possible. That is the easiest and cleanest way
8// to configure.
9//
10
f435778e 11 // This makes sure we don't load it dozens of times
12 // don't change this
13 if (defined('config_php'))
14 return;
15 define('config_php', true);
16
4011c3ca 17 // don't change
78692381 18 global $config_version;
6ef7145f 19 $config_version = "x63";
390372b4 20
baf93783 21// Organization's logo picture (blank if none)
78692381 22 global $org_logo;
baf93783 23 $org_logo = "../images/sm_logo.jpg";
24
25// Organization's name
78692381 26 global $org_name;
baf93783 27 $org_name = "SquirrelMail";
28
29// Webmail Title
30// This is the title that goes at the top of the browser window
78692381 31 global $org_title;
baf93783 32 $org_title = "SquirrelMail $version";
6ef7145f 33
34// Default language
35// This is the default language. It is used as a last resort if SquirrelMail
36// can't figure out which language to display.
37// Use the two-letter code.
38 global $squirrelmail_default_language;
4da27e4f 39 $squirrelmail_default_language = "en";
baf93783 40
41// The server that your imap server is on
78692381 42 global $imapServerAddress, $imapPort;
baf93783 43 $imapServerAddress = "localhost";
44 $imapPort = 143;
45
46// The domain where your email address is.
47// Example: in "luke@usa.om.org", usa.om.org is the domain.
48// this is for all the messages sent out. Reply address
49// is generated by $username@$domain
78692381 50 global $domain;
baf93783 51 $domain = "mydomain.com";
52
53// Your SMTP server and port number (usually the same as the IMAP server)
78692381 54 global $smtpServerAddress, $smtpPort;
baf93783 55 $smtpServerAddress = "localhost";
56 $smtpPort = 25;
57
58// Uncomment this if you want to deliver locally using sendmail instead
59// of connecting to a SMTP-server
78692381 60// global $useSendmail, $sendmail_path;
baf93783 61// $useSendmail = true;
62// $sendmail_path = "/usr/sbin/sendmail";
63
64// This is displayed right after they log in
78692381 65 global $motd;
a37f3771 66 $motd = "";
baf93783 67
baf93783 68// Whether or not to use a special color for special folders. If not, special
69// folders will be the same color as the other folders
78692381 70 global $use_special_folder_color;
baf93783 71 $use_special_folder_color = true;
72
51457ed2 73// The type of IMAP server you are running
74// Valid type are the following (case is important).
75//
76// courier
77// cyrus
78// exchange
79// uw
6ef7145f 80// other
78692381 81 global $imap_server_type;
51457ed2 82 $imap_server_type = "cyrus";
83
f923b93d 84// Rather than going to the signout.php page (which only allows you
85// to sign back in), setting signout_page allows you to sign
86// the user out and then redirect to whatever page you want.
87// For instance, the following would return the user to your
88// home page: $signout_page = "/";
89// Set to the empty string to continue to use the default signout page.
55c61345 90 global $signout_page;
f923b93d 91 $signout_page = "";
92
5479d709 93// Many servers store mail in your home directory. With this, they
cf85d665 94// store them in a subdirectory: mail/ or Mail/, etc. If your
5479d709 95// server does this, please set this to what the default mail folder
96// should be. This is still a user preference, so they can change
97// it if it is different for each user.
98//
99// Example:
cf85d665 100// $default_folder_prefix = "mail/";
5479d709 101// -- or --
cf85d665 102// $default_folder_prefix = "Mail/folders/";
5479d709 103//
104// If you do not use this, please set it to "".
78692381 105 global $default_folder_prefix;
cf85d665 106 $default_folder_prefix = "";
107// If you do not wish to give them the option to change this, set it to false.
108// Otherwise, if it is true, they can change the folder prefix to be anything.
78692381 109 global $show_prefix_option;
cf85d665 110 $show_prefix_option = false;
5479d709 111
ca1f4a68 112// The following are related to deleting messages.
113// $move_to_trash
114// - if this is set to "true", when "delete" is pressed, it
115// will attempt to move the selected messages to the folder
116// named $trash_folder. If it's set to "false", we won't even
117// attempt to move the messages, just delete them.
118// $trash_folder
119// - This is the path to the default trash folder. For Cyrus
120// IMAP, it would be "INBOX.Trash", but for UW it would be
121// "Trash". We need the full path name here.
122// $auto_expunge
123// - If this is true, when a message is moved or copied, the
124// source mailbox will get expunged, removing all messages
125// marked "Deleted".
e5370d43 126// $sent_folder
127// - This is the path to where Sent messages will be stored.
baf93783 128
78692381 129 global $default_move_to_trash, $default_move_to_sent, $trash_folder,
130 $auto_expunge, $sent_folder;
baf93783 131 $default_move_to_trash = true;
2f287147 132 $default_move_to_sent = true;
baf93783 133 $trash_folder = "INBOX.Trash";
134 $auto_expunge = true;
e5370d43 135 $sent_folder = "INBOX.Sent";
baf93783 136
ca1f4a68 137// Special Folders are folders that can't be manipulated like normal
138// user created folders can. A couple of examples would be
139// "INBOX.Trash", "INBOX.Drafts". We have them set to Netscape's
140// default mailboxes, but this obviously can be changed. To add one,
141// just add a new number to the array.
baf93783 142
78692381 143 global $special_folders;
baf93783 144 $special_folders[0] = "INBOX"; // The first one has to be the inbox (whatever the name is)
145 $special_folders[1] = $trash_folder;
a3886f39 146 $special_folders[2] = $sent_folder;
baf93783 147 $special_folders[3] = "INBOX.Drafts";
148 $special_folders[4] = "INBOX.Templates";
149
78546ff2 150// Should I create the Sent and Trash folders automatically for a new
151// user that doesn't already have them created?
152 global $auto_create_special;
153 $auto_create_special = true;
154
baf93783 155// Whether or not to list the special folders first (true/false)
78692381 156 global $list_special_folders_first;
baf93783 157 $list_special_folders_first = true;
158
159// Are all your folders subfolders of INBOX (i.e. cyrus IMAP server)
160// If you are not sure, set it to false.
78692381 161 global $default_sub_of_inbox;
baf93783 162 $default_sub_of_inbox = true;
163
ca1f4a68 164// Some IMAP daemons (UW) handle folders weird. They only allow a
165// folder to contain either messages or other folders, not both at
166// the same time. This option controls whether or not to display an
167// option during folder creation. The option toggles which type of
168// folder it should be.
baf93783 169//
ca1f4a68 170// If this option confuses you, make it "true". You can't hurt
171// anything if it's true, but some servers will respond weird if it's
172// false. (Cyrus works fine whether it's true OR false).
78692381 173 global $show_contain_subfolders_option;
baf93783 174 $show_contain_subfolders_option = false;
175
17ce8467 176// This option controls what character set is used when sending mail
177// and when sending HTMl to the browser. Do not set this to US-ASCII,
178// use ISO-8859-1 instead. For cyrillic it is best to use KOI8-R,
179// since this implementation is faster than the alternatives.
78692381 180 global $default_charset;
17ce8467 181 $default_charset = "iso-8859-1";
182
baf93783 183// Path to the data/ directory
ca1f4a68 184// It is a possible security hole to have a writable directory
185// under the web server's root directory (ex: /home/httpd/html).
186// For this reason, it is possible to put the data directory
187// anywhere you would like. The path name can be absolute or
188// relative (to the config directory). It doesn't matter. Here are
189// two examples:
baf93783 190//
191// Absolute:
192// $data_dir = "/usr/local/squirrelmail/data/";
193//
194// Relative (to the config directory):
195// $data_dir = "../data/";
78692381 196 global $data_dir;
baf93783 197 $data_dir = "../data/";
ca1f4a68 198
199// Path to directory used for storing attachments while a mail is
200// being sent. There are a few security considerations regarding this
201// directory:
202// - It should have the permission 733 (rwx-wx-wx) to make it
203// impossible for a random person with access to the webserver to
204// list files in this directory. Confidential data might be laying
205// around there
206// - Since the webserver is not able to list the files in the content
207// is also impossible for the webserver to delete files lying around
208// there for too long.
209// - It should probably be another directory than data_dir.
78692381 210 global $attachment_dir;
4df48d80 211 $attachment_dir = $data_dir;
2848c630 212
61d9e885 213// This is the default size of the folder list. Default is 150,
2848c630 214// but you can set it to whatever you wish.
78692381 215 global $default_left_size;
61d9e885 216 $default_left_size = 150;
17ce8467 217
985f7c88 218// Some IMAP servers allow a username (like "bob") to log in if they use
219// uppercase in their name (like "Bob" or "BOB"). This creates extra
220// preference files. Toggling this option to true will transparently
221// change all usernames to lowercase.
78692381 222 global $force_username_lowercase;
985f7c88 223 $force_username_lowercase = false;
224
225
17ce8467 226// Themes
227// You can define your own theme and put it in this directory. You must
228// call it as the example below. You can name the theme whatever you
229// want. For an example of a theme, see the ones included in the config
230// directory.
231//
17ce8467 232// To add a new theme to the options that users can choose from, just add
233// a new number to the array at the bottom, and follow the pattern.
78692381 234 global $theme;
17ce8467 235
236 // The first one HAS to be here, and is your system's default theme.
237 // It can be any theme you want
390372b4 238 $theme[0]["PATH"] = "../themes/default_theme.php";
17ce8467 239 $theme[0]["NAME"] = "Default";
240
390372b4 241 $theme[1]["PATH"] = "../themes/plain_blue_theme.php";
6170c5b6 242 $theme[1]["NAME"] = "Plain Blue";
17ce8467 243
390372b4 244 $theme[2]["PATH"] = "../themes/sandstorm_theme.php";
6170c5b6 245 $theme[2]["NAME"] = "Sand Storm";
17ce8467 246
390372b4 247 $theme[3]["PATH"] = "../themes/deepocean_theme.php";
6170c5b6 248 $theme[3]["NAME"] = "Deep Ocean";
17ce8467 249
390372b4 250 $theme[4]["PATH"] = "../themes/slashdot_theme.php";
6170c5b6 251 $theme[4]["NAME"] = "Slashdot";
17ce8467 252
390372b4 253 $theme[5]["PATH"] = "../themes/purple_theme.php";
6170c5b6 254 $theme[5]["NAME"] = "Purple";
17ce8467 255
390372b4 256 $theme[6]["PATH"] = "../themes/forest_theme.php";
6170c5b6 257 $theme[6]["NAME"] = "Forest";
17ce8467 258
390372b4 259 $theme[7]["PATH"] = "../themes/ice_theme.php";
6170c5b6 260 $theme[7]["NAME"] = "Ice";
17ce8467 261
390372b4 262 $theme[8]["PATH"] = "../themes/seaspray_theme.php";
6170c5b6 263 $theme[8]["NAME"] = "Sea Spray";
a871010c 264
390372b4 265 $theme[9]["PATH"] = "../themes/bluesteel_theme.php";
9d1c518c 266 $theme[9]["NAME"] = "Blue Steel";
59eff34d 267
390372b4 268 $theme[10]["PATH"] = "../themes/dark_grey_theme.php";
6170c5b6 269 $theme[10]["NAME"] = "Dark Grey";
270
390372b4 271 $theme[11]["PATH"] = "../themes/high_contrast_theme.php";
6170c5b6 272 $theme[11]["NAME"] = "High Contrast";
24fc5dd2 273
8af40496 274 $theme[12]["PATH"] = "../themes/black_bean_burrito_theme.php";
275 $theme[12]["NAME"] = "Black Bean Burrito";
0493a8d9 276
944eb785 277 $theme[13]["PATH"] = "../themes/servery_theme.php";
278 $theme[13]["NAME"] = "Servery";
279
6e0fa5e6 280 $theme[14]["PATH"] = "../themes/maize_theme.php";
281 $theme[14]["NAME"] = "Maize";
282
283 $theme[15]["PATH"] = "../themes/bluesnews_theme.php";
284 $theme[15]["NAME"] = "BluesNews";
285
59eff34d 286// LDAP server(s)
287//
288// Array of arrays with LDAP server parameters. See
289// functions/abook_ldap_server.php for a list of possible
290// parameters
74a7d5b0 291//
78692381 292global $ldap_server;
293//
74a7d5b0 294// EXAMPLE:
295//
296// $ldap_server[0] = Array(
297// "host" => "memberdir.netscape.com",
298// "name" => "Netcenter Member Directory",
299// "base" => "ou=member_directory,o=netcenter.com");
59eff34d 300
6ff1c690 301// Database-driven private addressbooks
302//
303// DSN (Data Source Name) for a database where the private
304// addressbooks are stored. See doc/db-backend.txt for more info.
305// If it is not defined, the addressbooks are stored in files
306// in the data dir.
307//
52c0ac47 308// global $addrbook_dsn;
6ff1c690 309// $addrbook_dsn = 'mysql://user:pass@hostname/dbname';
1e0628fb 310
59eff34d 311
3806fa52 312 // you have an option to chose between javascript or html version of
313 // address book searching.
314 // true = javascript
315 // false = html
78692381 316 global $default_use_javascript_addr_book;
3806fa52 317 $default_use_javascript_addr_book = false;
318
24fc5dd2 319 // these next two options set the defaults for the way that the users see
320 // their folder list.
321 // $default_unseen_notify specifies whether or not the users will see
322 // the number of unseen in each folder by default
323 // and alsy which folders to do this to.
324 // 1=none, 2=inbox, 3=all
325 // $default_unseen_type specifies the type of notification to give the
326 // users by default.
327 // 1=(4), 2=(4,25)
78692381 328 global $default_unseen_notify, $default_unseen_type;
24fc5dd2 329 $default_unseen_notify = 2;
330 $default_unseen_type = 1;
d47b2518 331
332 // If you are running on a machine that doesn't have the tm_gmtoff
333 // value in your time structure and if you are in a time zone that
334 // has a negative offset, you need to set this value to 1.
335 // This is typically people in the US that are running Solaris 7.
78692381 336 global $invert_time;
d47b2518 337 $invert_time = false;
0ae64f08 338
78692381 339 global $plugins;
ea0e9243 340 // To install plugins, just add elements to this array that have
341 // the plugin directory name relative to the /plugins/ directory.
342 // For instance, for the "sqclock" plugin, you'd put a line like
343 // the following:
344 // $plugins[0] = "sqclock";
88663c22 345 // $plugins[1] = "attachment_common";
ea0e9243 346
88663c22 347// Do not add the closing PHP tag here just because we want to avoid
348// the potential for parsing errors if there is a newline added