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