added a hook for Jimmy Conner
[squirrelmail.git] / config / config_default.php
1 <?php
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
11 /* Do not change this value. */
12 global $config_version;
13 $config_version = '1.2.0';
14
15 /* Organization's logo picture (blank if none) */
16 global $org_logo;
17 $org_logo = '../images/sm_logo.png';
18
19 /* The width of the logo (0 for default) */
20 $org_logo_width = 308;
21
22 /* The height of the logo (0 for default) */
23 $org_logo_height = 111;
24
25
26 /* Organization's name */
27 global $org_name;
28 $org_name = 'SquirrelMail';
29
30 /**
31 * Webmail Title
32 * This is the web page title that appears at the top of the browser window.
33 */
34 global $org_title;
35 $org_title = "SquirrelMail $version";
36
37 /**
38 * Default language
39 * This is the default language. It is used as a last resort
40 * if SquirrelMail can't figure out which language to display.
41 * Use the two-letter code.
42 */
43 global $squirrelmail_default_language;
44 $squirrelmail_default_language = 'en_US';
45
46 /* The dns name and port for your imap server. */
47 global $imapServerAddress, $imapPort;
48 $imapServerAddress = 'localhost';
49 $imapPort = 143;
50
51 /**
52 * The domain part of local email addresses.
53 * This is for all messages sent out from this server.
54 * Reply address is generated by $username@$domain
55 * Example: In bob@foo.com, foo.com is the domain.
56 */
57 global $domain;
58 $domain = 'mydomain.com';
59
60 /* Your SMTP server and port number (usually the same as the IMAP server). */
61 global $smtpServerAddress, $smtpPort;
62 $smtpServerAddress = 'localhost';
63 $smtpPort = 25;
64
65 /**
66 * Uncomment this if you want to deliver locally using sendmail
67 * instead of connecting to a SMTP-server.
68 */
69 #global $useSendmail, $sendmail_path;
70 #$useSendmail = true;
71 #$sendmail_path = '/usr/sbin/sendmail';
72
73 /* This is a message that is displayed immediately after a user logs in. */
74 global $motd;
75 $motd = '';
76
77 /**
78 * Whether or not to use a special color for special folders. If not,
79 * special folders will be the same color as the other folders.
80 */
81 global $use_special_folder_color;
82 $use_special_folder_color = true;
83
84 /**
85 * The type of IMAP server you are running.
86 * Valid type are the following (case is important):
87 * courier
88 * cyrus
89 * exchange
90 * uw
91 * other
92 */
93 global $imap_server_type;
94 $imap_server_type = 'cyrus';
95
96 /**
97 * Rather than going to the signout.php page (which only allows you
98 * to sign back in), setting signout_page allows you to sign the user
99 * out and then redirect to whatever page you want. For instance,
100 * the following would return the user to your home page:
101 * $signout_page = '/';
102 * Set to the empty string to continue to use the default signout page.
103 */
104 global $signout_page;
105 $signout_page = '';
106
107 /**
108 * Many servers store mail in your home directory. With this, they
109 * store them in a subdirectory: mail/ or Mail/, etc. If your server
110 * does this, please set this to what the default mail folder should
111 * be. This is still a user preference, so they can change it if it
112 * is different for each user.
113 *
114 * Example:
115 * $default_folder_prefix = 'mail/';
116 * -- or --
117 * $default_folder_prefix = 'Mail/folders/';
118 *
119 * If you do not use this, set it to the empty string.
120 */
121 global $default_folder_prefix;
122 $default_folder_prefix = '';
123
124 /**
125 * If you do not wish to give them the option to change this, set it
126 * to false. Otherwise, if it is true, they can change the folder prefix
127 * to be anything.
128 */
129 global $show_prefix_option;
130 $show_prefix_option = false;
131
132 /**
133 * The following are related to deleting messages.
134 * $move_to_trash
135 * if this is set to 'true', when 'delete' is pressed, it
136 * will attempt to move the selected messages to the folder
137 * named $trash_folder. If it's set to 'false', we won't even
138 * attempt to move the messages, just delete them.
139 * $trash_folder
140 * This is the path to the default trash folder. For Cyrus
141 * IMAP, it would be 'INBOX.Trash', but for UW it would be
142 * 'Trash'. We need the full path name here.
143 * $auto_expunge
144 * If this is true, when a message is moved or copied, the
145 * source mailbox will get expunged, removing all messages
146 * marked 'Deleted'.
147 * $sent_folder
148 * This is the path to where Sent messages will be stored.
149 * $delete_folder
150 * If this is true, when a folder is deleted then it will
151 * not get moved into the Trash folder.
152 */
153 global $default_move_to_trash, $default_move_to_sent, $default_save_as_draft;
154 global $trash_folder, $sent_folder, $draft_folder, $auto_expunge;
155 global $delete_folder;
156 $default_move_to_trash = true;
157 $default_move_to_sent = true;
158 $default_save_as_draft = true;
159 $trash_folder = 'INBOX.Trash';
160 $sent_folder = 'INBOX.Sent';
161 $draft_folder = 'INBOX.Drafts';
162 $auto_expunge = true;
163 $delete_folder = false;
164
165 /**
166 * Should I create the Sent and Trash folders automatically for
167 * a new user that doesn't already have them created?
168 */
169 global $auto_create_special;
170 $auto_create_special = true;
171
172 /* Whether or not to list the special folders first (true/false). */
173 global $list_special_folders_first;
174 $list_special_folders_first = true;
175
176 /**
177 * Are all your folders subfolders of INBOX (i.e. cyrus IMAP server).
178 * If you are unsure, set it to false.
179 */
180 global $default_sub_of_inbox;
181 $default_sub_of_inbox = true;
182
183 /**
184 * Some IMAP daemons (UW) handle folders weird. They only allow a
185 * folder to contain either messages or other folders, not both at
186 * the same time. This option controls whether or not to display an
187 * option during folder creation. The option toggles which type of
188 * folder it should be.
189 *
190 * If this option confuses you, just set it to 'true'. You can not hurt
191 * anything if it's true, but some servers will respond weird if it's
192 * false. (Cyrus works fine whether it's true OR false).
193 */
194 global $show_contain_subfolders_option;
195 $show_contain_subfolders_option = false;
196
197 /**
198 * This option controls what character set is used when sending mail
199 * and when sending HTMl to the browser. Do not set this to US-ASCII,
200 * use ISO-8859-1 instead. For cyrillic it is best to use KOI8-R,
201 * since this implementation is faster than the alternatives.
202 */
203 global $default_charset;
204 $default_charset = 'iso-8859-1';
205
206 /**
207 * Path to the data/ directory
208 * It is a possible security hole to have a writable directory
209 * under the web server's root directory (ex: /home/httpd/html).
210 * For this reason, it is possible to put the data directory
211 * anywhere you would like. The path name can be absolute or
212 * relative (to the config directory). It doesn't matter. Here
213 * are two examples:
214 *
215 * Absolute:
216 * $data_dir = '/usr/local/squirrelmail/data/';
217 *
218 * Relative (to the config directory):
219 * $data_dir = '../data/';
220 */
221 global $data_dir;
222 $data_dir = '../data/';
223
224 /**
225 * Path to directory used for storing attachments while a mail is
226 * being sent. There are a few security considerations regarding
227 * this directory:
228 * + It should have the permission 733 (rwx-wx-wx) to make it
229 * impossible for a random person with access to the webserver to
230 * list files in this directory. Confidential data might be laying
231 * around there.
232 * + Since the webserver is not able to list the files in the content
233 * is also impossible for the webserver to delete files lying around
234 * there for too long.
235 * + It should probably be another directory than data_dir.
236 */
237 global $attachment_dir;
238 $attachment_dir = "$data_dir";
239
240 /* Hash level used for data directory. */
241 global $dir_hash_level;
242 $dir_hash_level = 0;
243
244 /**
245 * This is the default size of the folder list. Default
246 * is 150, but you can set it to whatever you wish.
247 */
248 global $default_left_size;
249 $default_left_size = 150;
250
251 /**
252 * Some IMAP servers allow a username (like 'bob') to log in if they use
253 * uppercase in their name (like 'Bob' or 'BOB'). This creates extra
254 * preference files. Toggling this option to true will transparently
255 * change all usernames to lowercase.
256 */
257 global $force_username_lowercase;
258 $force_username_lowercase = false;
259
260 /**
261 * Themes
262 * You can define your own theme and put it in this directory.
263 * You must call it as the example below. You can name the theme
264 * whatever you want. For an example of a theme, see the ones
265 * included in the config directory.
266 *
267 * To add a new theme to the options that users can choose from, just
268 * add a new number to the array at the bottom, and follow the pattern.
269 */
270 global $theme;
271
272 /**
273 * The first one HAS to be here, and is your system's default
274 * theme. It can be any theme you want.
275 */
276 $theme[0]['PATH'] = '../themes/default_theme.php';
277 $theme[0]['NAME'] = 'Default';
278
279 $theme[1]['PATH'] = '../themes/plain_blue_theme.php';
280 $theme[1]['NAME'] = 'Plain Blue';
281
282 $theme[2]['PATH'] = '../themes/sandstorm_theme.php';
283 $theme[2]['NAME'] = 'Sand Storm';
284
285 $theme[3]['PATH'] = '../themes/deepocean_theme.php';
286 $theme[3]['NAME'] = 'Deep Ocean';
287
288 $theme[4]['PATH'] = '../themes/slashdot_theme.php';
289 $theme[4]['NAME'] = 'Slashdot';
290
291 $theme[5]['PATH'] = '../themes/purple_theme.php';
292 $theme[5]['NAME'] = 'Purple';
293
294 $theme[6]['PATH'] = '../themes/forest_theme.php';
295 $theme[6]['NAME'] = 'Forest';
296
297 $theme[7]['PATH'] = '../themes/ice_theme.php';
298 $theme[7]['NAME'] = 'Ice';
299
300 $theme[8]['PATH'] = '../themes/seaspray_theme.php';
301 $theme[8]['NAME'] = 'Sea Spray';
302
303 $theme[9]['PATH'] = '../themes/bluesteel_theme.php';
304 $theme[9]['NAME'] = 'Blue Steel';
305
306 $theme[10]['PATH'] = '../themes/dark_grey_theme.php';
307 $theme[10]['NAME'] = 'Dark Grey';
308
309 $theme[11]['PATH'] = '../themes/high_contrast_theme.php';
310 $theme[11]['NAME'] = 'High Contrast';
311
312 $theme[12]['PATH'] = '../themes/black_bean_burrito_theme.php';
313 $theme[12]['NAME'] = 'Black Bean Burrito';
314
315 $theme[13]['PATH'] = '../themes/servery_theme.php';
316 $theme[13]['NAME'] = 'Servery';
317
318 $theme[14]['PATH'] = '../themes/maize_theme.php';
319 $theme[14]['NAME'] = 'Maize';
320
321 $theme[15]['PATH'] = '../themes/bluesnews_theme.php';
322 $theme[15]['NAME'] = 'BluesNews';
323
324 $theme[16]['PATH'] = '../themes/deepocean2_theme.php';
325 $theme[16]['NAME'] = 'Deep Ocean 2';
326
327 $theme[17]['PATH'] = '../themes/blue_grey_theme.php';
328 $theme[17]['NAME'] = 'Blue Grey';
329
330 $theme[18]['PATH'] = '../themes/dompie_theme.php';
331 $theme[18]['NAME'] = 'Dompie';
332
333 $theme[19]['PATH'] = '../themes/methodical_theme.php';
334 $theme[19]['NAME'] = 'Methodical';
335
336 $theme[20]['PATH'] = '../themes/greenhouse_effect.php';
337 $theme[20]['NAME'] = 'Greenhouse Effect (Changes)';
338
339 $theme[21]['PATH'] = '../themes/in_the_pink.php';
340 $theme[21]['NAME'] = 'In The Pink (Changes)';
341
342 $theme[22]['PATH'] = '../themes/kind_of_blue.php';
343 $theme[22]['NAME'] = 'Kind of Blue (Changes)';
344
345 $theme[23]['PATH'] = '../themes/monostochastic.php';
346 $theme[23]['NAME'] = 'Monostochastic (Changes)';
347
348 $theme[24]['PATH'] = '../themes/shades_of_grey.php';
349 $theme[24]['NAME'] = 'Shades of Grey (Changes)';
350
351 $theme[25]['PATH'] = '../themes/spice_of_life.php';
352 $theme[25]['NAME'] = 'Spice of Life (Changes)';
353
354 $theme[26]['PATH'] = '../themes/spice_of_life_lite.php';
355 $theme[26]['NAME'] = 'Spice of Life - Lite (Changes)';
356
357 $theme[27]['PATH'] = '../themes/spice_of_life_dark.php';
358 $theme[27]['NAME'] = 'Spice of Life - Dark (Changes)';
359
360 $theme[28]['PATH'] = '../themes/christmas.php';
361 $theme[28]['NAME'] = 'Holiday - Christmas';
362
363 $theme[29]['PATH'] = '../themes/darkness.php';
364 $theme[29]['NAME'] = 'Darkness (Changes)';
365
366 $theme[30]['PATH'] = '../themes/random.php';
367 $theme[30]['NAME'] = 'Random (Changes every login)';
368
369 $theme[31]['PATH'] = '../themes/midnight.php';
370 $theme[31]['NAME'] = 'Midnight';
371
372 /**
373 * LDAP server(s)
374 * Array of arrays with LDAP server parameters. See
375 * functions/abook_ldap_server.php for a list of possible
376 * parameters
377 *
378 * EXAMPLE:
379 * $ldap_server[0] = Array(
380 * 'host' => 'memberdir.netscape.com',
381 * 'name' => 'Netcenter Member Directory',
382 * 'base' => 'ou=member_directory,o=netcenter.com'
383 * );
384 */
385 global $ldap_server;
386
387 /**
388 * Database-driven private addressbooks
389 * DSN (Data Source Name) for a database where the private
390 * addressbooks are stored. See doc/db-backend.txt for more info.
391 * If it is not set, the addressbooks are stored in files
392 * in the data dir.
393 * The DSN is in the format: mysql://user:pass@hostname/dbname
394 * The table is the name of the table to use within the
395 * specified database.
396 */
397 global $addrbook_dsn, $addrbook_table;
398 $addrbook_dsn = '';
399 $addrbook_table = 'address';
400
401 global $prefs_dsn, $prefs_table;
402 $prefs_dsn = '';
403 $prefs_table = 'userprefs';
404
405 /**
406 * Users may search their addressbook via either a plain HTML or Javascript
407 * enhanced user interface. This option allows you to set the default choice.
408 * Set this default choice as either:
409 * true = javascript
410 * false = html
411 */
412 global $default_use_javascript_addr_book;
413 $default_use_javascript_addr_book = false;
414
415 /**
416 * These next two options set the defaults for the way that the
417 * users see their folder list.
418 * $default_unseen_notify
419 * Specifies whether or not the users will see the number of
420 * unseen in each folder by default and also which folders to
421 * do this to. Valid values are: 1=none, 2=inbox, 3=all.
422 * $default_unseen_type
423 * Specifies the type of notification to give the users by
424 * default. Valid choice are: 1=(4), 2=(4,25).
425 */
426 global $default_unseen_notify, $default_unseen_type;
427 $default_unseen_notify = 2;
428 $default_unseen_type = 1;
429
430 /**
431 * If you are running on a machine that doesn't have the tm_gmtoff
432 * value in your time structure and if you are in a time zone that
433 * has a negative offset, you need to set this value to 1. This is
434 * typically people in the US that are running Solaris 7.
435 */
436 global $invert_time;
437 $invert_time = false;
438
439 /**
440 * By default SquirrelMail takes up the whole browser window,
441 * this allows you to embed it within sites using frames. Set
442 * this to the frame you want it to stay in.
443 */
444
445 global $frame_top;
446 $frame_top = '_top';
447
448 global $plugins;
449 /**
450 * To install plugins, just add elements to this array that have
451 * the plugin directory name relative to the /plugins/ directory.
452 * For instance, for the 'sqclock' plugin, you'd put a line like
453 * the following.
454 * $plugins[0] = 'sqclock';
455 * $plugins[1] = 'attachment_common';
456 */
457
458 /**
459 * If you don't want to allow users to change their email address
460 * then you can set $edit_identity to false, if you want them to
461 * not be able to change their full name too then set $edit_name
462 * to false as well. $edit_name has no effect unless $edit_identity
463 * is false;
464 */
465
466 global $edit_identity, $edit_name;
467 $edit_identity = true;
468 $edit_name = true;
469
470
471 /**
472 * If you want to enable server side thread sorting options
473 * Your IMAP server must support the THREAD extension for
474 * this to work.
475 */
476
477 global $allow_thread_sort;
478 $allow_thread_sort = false;
479
480 /**
481 * to use server-side sorting instead of SM client side.
482 * Your IMAP server must support the SORT extension for this
483 * to work.
484 */
485 global $allow_server_sort;
486 $allow_server_sort = false;
487
488 /**
489 * Make sure there are no characters after the PHP closing
490 * tag below (including newline characters and whitespace).
491 * Otherwise, that character will cause the headers to be
492 * sent and regular output to begin, which will majorly screw
493 * things up when we try to send more headers later.
494 */
495 ?>