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