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