c965d4c0cd88fa3549436ef3e0b3f03cec4a4a2c
[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 /* Organization's name */
20 global $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 */
27 global $org_title;
28 $org_title = 'SquirrelMail $version';
29
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 */
36 global $squirrelmail_default_language;
37 $squirrelmail_default_language = 'en_US';
38
39 /* The dns name and port for your imap server. */
40 global $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 */
50 global $domain;
51 $domain = 'mydomain.com';
52
53 /* Your SMTP server and port number (usually the same as the IMAP server). */
54 global $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. */
67 global $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 */
74 global $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 */
86 global $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 */
97 global $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 */
114 global $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 */
122 global $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 * $delete_folder
143 * If this is true, when a folder is deleted then it will
144 * not get moved into the Trash folder.
145 */
146 global $default_move_to_trash, $default_move_to_sent, $default_save_as_draft;
147 global $trash_folder, $sent_folder, $draft_folder, $auto_expunge;
148 global $delete_folder;
149 $default_move_to_trash = true;
150 $default_move_to_sent = true;
151 $default_save_as_draft = true;
152 $trash_folder = 'INBOX.Trash';
153 $sent_folder = 'INBOX.Sent';
154 $draft_folder = 'INBOX.Drafts';
155 $auto_expunge = true;
156 $delete_folder = false;
157
158 /**
159 * Should I create the Sent and Trash folders automatically for
160 * a new user that doesn't already have them created?
161 */
162 global $auto_create_special;
163 $auto_create_special = true;
164
165 /* Whether or not to list the special folders first (true/false). */
166 global $list_special_folders_first;
167 $list_special_folders_first = true;
168
169 /**
170 * Are all your folders subfolders of INBOX (i.e. cyrus IMAP server).
171 * If you are unsure, set it to false.
172 */
173 global $default_sub_of_inbox;
174 $default_sub_of_inbox = true;
175
176 /**
177 * Some IMAP daemons (UW) handle folders weird. They only allow a
178 * folder to contain either messages or other folders, not both at
179 * the same time. This option controls whether or not to display an
180 * option during folder creation. The option toggles which type of
181 * folder it should be.
182 *
183 * If this option confuses you, just set it to 'true'. You can not hurt
184 * anything if it's true, but some servers will respond weird if it's
185 * false. (Cyrus works fine whether it's true OR false).
186 */
187 global $show_contain_subfolders_option;
188 $show_contain_subfolders_option = false;
189
190 /**
191 * This option controls what character set is used when sending mail
192 * and when sending HTMl to the browser. Do not set this to US-ASCII,
193 * use ISO-8859-1 instead. For cyrillic it is best to use KOI8-R,
194 * since this implementation is faster than the alternatives.
195 */
196 global $default_charset;
197 $default_charset = 'iso-8859-1';
198
199 /**
200 * Path to the data/ directory
201 * It is a possible security hole to have a writable directory
202 * under the web server's root directory (ex: /home/httpd/html).
203 * For this reason, it is possible to put the data directory
204 * anywhere you would like. The path name can be absolute or
205 * relative (to the config directory). It doesn't matter. Here
206 * are two examples:
207 *
208 * Absolute:
209 * $data_dir = '/usr/local/squirrelmail/data/';
210 *
211 * Relative (to the config directory):
212 * $data_dir = '../data/';
213 */
214 global $data_dir;
215 $data_dir = '../data/';
216
217 /**
218 * Path to directory used for storing attachments while a mail is
219 * being sent. There are a few security considerations regarding
220 * this directory:
221 * + It should have the permission 733 (rwx-wx-wx) to make it
222 * impossible for a random person with access to the webserver to
223 * list files in this directory. Confidential data might be laying
224 * around there.
225 * + Since the webserver is not able to list the files in the content
226 * is also impossible for the webserver to delete files lying around
227 * there for too long.
228 * + It should probably be another directory than data_dir.
229 */
230 global $attachment_dir;
231 $attachment_dir = "$data_dir";
232
233 /* Hash level used for data directory. */
234 global $dir_hash_level;
235 $dir_hash_level = 0;
236
237 /**
238 * This is the default size of the folder list. Default
239 * is 150, but you can set it to whatever you wish.
240 */
241 global $default_left_size;
242 $default_left_size = 150;
243
244 /**
245 * Some IMAP servers allow a username (like 'bob') to log in if they use
246 * uppercase in their name (like 'Bob' or 'BOB'). This creates extra
247 * preference files. Toggling this option to true will transparently
248 * change all usernames to lowercase.
249 */
250 global $force_username_lowercase;
251 $force_username_lowercase = false;
252
253 /**
254 * Themes
255 * You can define your own theme and put it in this directory.
256 * You must call it as the example below. You can name the theme
257 * whatever you want. For an example of a theme, see the ones
258 * included in the config directory.
259 *
260 * To add a new theme to the options that users can choose from, just
261 * add a new number to the array at the bottom, and follow the pattern.
262 */
263 global $theme;
264
265 /**
266 * The first one HAS to be here, and is your system's default
267 * theme. It can be any theme you want.
268 */
269 $theme[0]['PATH'] = '../themes/default_theme.php';
270 $theme[0]['NAME'] = 'Default';
271
272 $theme[1]['PATH'] = '../themes/plain_blue_theme.php';
273 $theme[1]['NAME'] = 'Plain Blue';
274
275 $theme[2]['PATH'] = '../themes/sandstorm_theme.php';
276 $theme[2]['NAME'] = 'Sand Storm';
277
278 $theme[3]['PATH'] = '../themes/deepocean_theme.php';
279 $theme[3]['NAME'] = 'Deep Ocean';
280
281 $theme[4]['PATH'] = '../themes/slashdot_theme.php';
282 $theme[4]['NAME'] = 'Slashdot';
283
284 $theme[5]['PATH'] = '../themes/purple_theme.php';
285 $theme[5]['NAME'] = 'Purple';
286
287 $theme[6]['PATH'] = '../themes/forest_theme.php';
288 $theme[6]['NAME'] = 'Forest';
289
290 $theme[7]['PATH'] = '../themes/ice_theme.php';
291 $theme[7]['NAME'] = 'Ice';
292
293 $theme[8]['PATH'] = '../themes/seaspray_theme.php';
294 $theme[8]['NAME'] = 'Sea Spray';
295
296 $theme[9]['PATH'] = '../themes/bluesteel_theme.php';
297 $theme[9]['NAME'] = 'Blue Steel';
298
299 $theme[10]['PATH'] = '../themes/dark_grey_theme.php';
300 $theme[10]['NAME'] = 'Dark Grey';
301
302 $theme[11]['PATH'] = '../themes/high_contrast_theme.php';
303 $theme[11]['NAME'] = 'High Contrast';
304
305 $theme[12]['PATH'] = '../themes/black_bean_burrito_theme.php';
306 $theme[12]['NAME'] = 'Black Bean Burrito';
307
308 $theme[13]['PATH'] = '../themes/servery_theme.php';
309 $theme[13]['NAME'] = 'Servery';
310
311 $theme[14]['PATH'] = '../themes/maize_theme.php';
312 $theme[14]['NAME'] = 'Maize';
313
314 $theme[15]['PATH'] = '../themes/bluesnews_theme.php';
315 $theme[15]['NAME'] = 'BluesNews';
316
317 $theme[16]['PATH'] = '../themes/deepocean2_theme.php';
318 $theme[16]['NAME'] = 'Deep Ocean 2';
319
320 $theme[17]['PATH'] = '../themes/blue_grey_theme.php';
321 $theme[17]['NAME'] = 'Blue Grey';
322
323 $theme[18]['PATH'] = '../themes/dompie_theme.php';
324 $theme[18]['NAME'] = 'Dompie';
325
326 $theme[19]['PATH'] = '../themes/methodical_theme.php';
327 $theme[19]['NAME'] = 'Methodical';
328
329 $theme[20]['PATH'] = '../themes/greenhouse_effect.php';
330 $theme[20]['NAME'] = 'Greenhouse Effect (Changes)';
331
332 $theme[21]['PATH'] = '../themes/in_the_pink.php';
333 $theme[21]['NAME'] = 'In The Pink (Changes)';
334
335 $theme[22]['PATH'] = '../themes/kind_of_blue.php';
336 $theme[22]['NAME'] = 'Kind of Blue (Changes)';
337
338 $theme[23]['PATH'] = '../themes/monostochastic.php';
339 $theme[23]['NAME'] = 'Monostochastic (Changes)';
340
341 $theme[24]['PATH'] = '../themes/shades_of_grey.php';
342 $theme[24]['NAME'] = 'Shades of Grey (Changes)';
343
344 $theme[25]['PATH'] = '../themes/spice_of_life.php';
345 $theme[25]['NAME'] = 'Spice of Life (Changes)';
346
347 $theme[26]['PATH'] = '../themes/spice_of_life_lite.php';
348 $theme[26]['NAME'] = 'Spice of Life - Lite (Changes)';
349
350 $theme[27]['PATH'] = '../themes/spice_of_life_dark.php';
351 $theme[27]['NAME'] = 'Spice of Life - Dark (Changes)';
352
353 $theme[28]['PATH'] = '../themes/christmas.php';
354 $theme[28]['NAME'] = 'Holiday - Christmas';
355
356 $theme[29]['PATH'] = '../themes/darkness.php';
357 $theme[29]['NAME'] = 'Darkness (Changes)';
358
359 $theme[30]['PATH'] = '../themes/random.php';
360 $theme[30]['NAME'] = 'Random (Changes every login)';
361
362 $theme[31]['PATH'] = '../themes/midnight.php';
363 $theme[31]['NAME'] = 'Midnight';
364
365 /**
366 * LDAP server(s)
367 * Array of arrays with LDAP server parameters. See
368 * functions/abook_ldap_server.php for a list of possible
369 * parameters
370 *
371 * EXAMPLE:
372 * $ldap_server[0] = Array(
373 * 'host' => 'memberdir.netscape.com',
374 * 'name' => 'Netcenter Member Directory',
375 * 'base' => 'ou=member_directory,o=netcenter.com'
376 * );
377 */
378 global $ldap_server;
379
380 /**
381 * Database-driven private addressbooks
382 * DSN (Data Source Name) for a database where the private
383 * addressbooks are stored. See doc/db-backend.txt for more info.
384 * If it is not set, the addressbooks are stored in files
385 * in the data dir.
386 * The DSN is in the format: mysql://user:pass@hostname/dbname
387 * The table is the name of the table to use within the
388 * specified database.
389 */
390 global $addrbook_dsn, $addrbook_table;
391 $addrbook_dsn = '';
392 $addrbook_table = 'address';
393
394 global $prefs_dsn, $prefs_table;
395 $prefs_dsn = '';
396 $prefs_table = 'userprefs';
397
398 /**
399 * Users may search their addressbook via either a plain HTML or Javascript
400 * enhanced user interface. This option allows you to set the default choice.
401 * Set this default choice as either:
402 * true = javascript
403 * false = html
404 */
405 global $default_use_javascript_addr_book;
406 $default_use_javascript_addr_book = false;
407
408 /**
409 * These next two options set the defaults for the way that the
410 * users see their folder list.
411 * $default_unseen_notify
412 * Specifies whether or not the users will see the number of
413 * unseen in each folder by default and also which folders to
414 * do this to. Valid values are: 1=none, 2=inbox, 3=all.
415 * $default_unseen_type
416 * Specifies the type of notification to give the users by
417 * default. Valid choice are: 1=(4), 2=(4,25).
418 */
419 global $default_unseen_notify, $default_unseen_type;
420 $default_unseen_notify = 2;
421 $default_unseen_type = 1;
422
423 /**
424 * If you are running on a machine that doesn't have the tm_gmtoff
425 * value in your time structure and if you are in a time zone that
426 * has a negative offset, you need to set this value to 1. This is
427 * typically people in the US that are running Solaris 7.
428 */
429 global $invert_time;
430 $invert_time = false;
431
432 /**
433 * By default SquirrelMail takes up the whole browser window,
434 * this allows you to embed it within sites using frames. Set
435 * this to the frame you want it to stay in.
436 */
437
438 global $frame_top;
439 $frame_top = '_top';
440
441 global $plugins;
442 /**
443 * To install plugins, just add elements to this array that have
444 * the plugin directory name relative to the /plugins/ directory.
445 * For instance, for the 'sqclock' plugin, you'd put a line like
446 * the following.
447 * $plugins[0] = 'sqclock';
448 * $plugins[1] = 'attachment_common';
449 */
450
451 /**
452 * Make sure there are no characters after the PHP closing
453 * tag below (including newline characters and whitespace).
454 * Otherwise, that character will cause the headers to be
455 * sent and regular output to begin, which will majorly screw
456 * things up when we try to send more headers later.
457 */
458 ?>