1. added non anonymous ldap binding patch. (thanks to Ilyak Kasnacheev <ilyak at...
[squirrelmail.git] / config / config_default.php
1 <?php
2
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. */
13 global $version;
14 global $config_version;
15 $config_version = '1.4.0';
16
17 /*** Organization preferences ***/
18 /**
19 * Organization's name
20 */
21 $org_name = "SquirrelMail";
22
23 /**
24 * Organization's logo picture (blank if none)
25 */
26 $org_logo = SM_PATH . 'images/sm_logo.png';
27
28 /**
29 * The width of the logo (0 for default)
30 */
31 $org_logo_width = '308';
32
33 /**
34 * The height of the logo (0 for default)
35 */
36 $org_logo_height = '111';
37
38 /**
39 * Webmail Title
40 * This is the web page title that appears at the top of the browser window.
41 */
42 $org_title = "SquirrelMail $version";
43
44 /**
45 * Rather than going to the signout.php page (which only allows you
46 * to sign back in), setting signout_page allows you to sign the user
47 * out and then redirect to whatever page you want. For instance,
48 * the following would return the user to your home page:
49 * $signout_page = '/';
50 * Set to the empty string to continue to use the default signout page.
51 */
52 $signout_page = '';
53
54 /**
55 * By default SquirrelMail takes up the whole browser window,
56 * this allows you to embed it within sites using frames. Set
57 * this to the frame you want it to stay in.
58 */
59 $frame_top = '_top';
60
61 /**
62 * Here you can set link displayed on the right side of main page.
63 * $provider_name sets name of link
64 * $provider_url set address used in the link
65 *
66 * Link will be displayed only if you have $hide_sm_attributions
67 * option set to true.
68 */
69 $provider_name = 'SquirrelMail';
70 $provider_uri = 'http://www.squirrelmail.org/';
71
72
73 /*** Server Settings ***/
74 /**
75 * The domain part of local email addresses.
76 * This is for all messages sent out from this server.
77 * Reply address is generated by $username@$domain
78 * Example: In bob@foo.com, foo.com is the domain.
79 */
80 $domain = 'example.com';
81
82 /**
83 * If you are running on a machine that doesn't have the tm_gmtoff
84 * value in your time structure and if you are in a time zone that
85 * has a negative offset, you need to set this value to 1. This is
86 * typically people in the US that are running Solaris 7.
87 */
88 $invert_time = false;
89
90 /**
91 * What should be used when sending email.
92 * If it is set to false, SquirrelMail will use SMTP server settings.
93 * If it is set to true, SquirrelMail will use program defined in
94 * $sendmail_path
95 */
96 $useSendmail = false;
97
98 /**
99 * Your SMTP server and port number (usually the same as the IMAP server).
100 */
101 $smtpServerAddress = 'localhost';
102 $smtpPort = 25;
103
104 /**
105 * Program that should be used when sending email. SquirrelMail expects that
106 * this program will follow options used by original sendmail
107 * (http://www.sendmail.org).
108 */
109 $sendmail_path = '/usr/sbin/sendmail';
110
111 /**
112 * The dns name (or IP address) and port for your imap server.
113 */
114 $imapServerAddress = 'localhost';
115 $imapPort = 143;
116
117 /**
118 * The type of IMAP server you are running.
119 * Valid type are the following (case is important):
120 * courier
121 * cyrus
122 * exchange
123 * uw
124 * macosx
125 * mercury32
126 * other
127 *
128 * Please note that this changes only some of server settings.
129 *
130 * In order to set everything correctly, you need to adjust several
131 * squirrelmail options. These options are listed in doc/presets.txt
132 */
133 $imap_server_type = 'other';
134
135 /**
136 * Advanced authentication options
137 * CRAM-MD5, DIGEST-MD5, Plain, and TLS
138 * Set reasonable defaults - you'd never know this was there unless you ask for it
139 */
140 $use_imap_tls = false;
141 $use_smtp_tls = false;
142
143 /**
144 * auth_mech can be either 'login','plain', 'cram-md5', or 'digest-md5'
145 * SMTP can also be 'none'
146 */
147 $smtp_auth_mech = 'none';
148 $imap_auth_mech = 'login';
149
150 /**
151 * This is the delimiter that your IMAP server uses to distinguish between
152 * folders. For example, Cyrus uses '.' as the delimiter and a complete
153 * folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would
154 * look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'
155 * but if you are sure you know what delimiter your server uses, you can
156 * specify it here.
157 *
158 * To have it autodetect the delimiter, set it to 'detect'.
159 */
160 $optional_delimiter = 'detect';
161
162 /**
163 * Do you wish to use POP3 before SMTP? Your server must
164 * support this in order for SquirrelMail to work with it.
165 */
166 $pop_before_smtp = false;
167
168
169 /*** Folder Settings ***/
170 /**
171 * Many servers store mail in your home directory. With this, they
172 * store them in a subdirectory: mail/ or Mail/, etc. If your server
173 * does this, please set this to what the default mail folder should
174 * be. This is still a user preference, so they can change it if it
175 * is different for each user.
176 *
177 * Example:
178 * $default_folder_prefix = 'mail/';
179 * -- or --
180 * $default_folder_prefix = 'Mail/folders/';
181 *
182 * If you do not use this, set it to the empty string.
183 */
184 $default_folder_prefix = '';
185
186 /**
187 * If you do not wish to give them the option to change this, set it
188 * to false. Otherwise, if it is true, they can change the folder prefix
189 * to be anything.
190 */
191 $show_prefix_option = false;
192
193 /**
194 * The following are related to deleting messages.
195 * $default_move_to_trash
196 * If this is set to 'true', when 'delete' is pressed, it
197 * will attempt to move the selected messages to the folder
198 * named $trash_folder. If it's set to 'false', we won't even
199 * attempt to move the messages, just delete them.
200 * $default_move_to_sent
201 * If this is set to 'true', sent messages will be stored in
202 * $sent_folder by default.
203 * $default_save_as_draft
204 * If this is set to 'true', users are able to use $draft_folder
205 * to store their unfinished messages.
206 * $trash_folder
207 * This is the path to the default trash folder. For Cyrus
208 * IMAP, it would be 'INBOX.Trash', but for UW it would be
209 * 'Trash'. We need the full path name here.
210 * $draft_folder
211 * This is the patch to where Draft messages will be stored.
212 * $auto_expunge
213 * If this is true, when a message is moved or copied, the
214 * source mailbox will get expunged, removing all messages
215 * marked 'Deleted'.
216 * $sent_folder
217 * This is the path to where Sent messages will be stored.
218 * $delete_folder
219 * If this is true, when a folder is deleted then it will
220 * not get moved into the Trash folder.
221 */
222 $default_move_to_trash = true;
223 $default_move_to_sent = true;
224 $default_save_as_draft = true;
225 $trash_folder = 'INBOX.Trash';
226 $sent_folder = 'INBOX.Sent';
227 $draft_folder = 'INBOX.Drafts';
228 $auto_expunge = true;
229 $delete_folder = false;
230
231 /**
232 * Whether or not to use a special color for special folders. If not,
233 * special folders will be the same color as the other folders.
234 */
235 $use_special_folder_color = true;
236
237 /**
238 * Should I create the Sent and Trash folders automatically for
239 * a new user that doesn't already have them created?
240 */
241 $auto_create_special = true;
242
243 /* Whether or not to list the special folders first (true/false). */
244 $list_special_folders_first = true;
245
246 /**
247 * Are all your folders subfolders of INBOX (i.e. cyrus IMAP server).
248 * If you are unsure, set it to false.
249 */
250 $default_sub_of_inbox = true;
251
252 /**
253 * Some IMAP daemons (UW) handle folders weird. They only allow a
254 * folder to contain either messages or other folders, not both at
255 * the same time. This option controls whether or not to display an
256 * option during folder creation. The option toggles which type of
257 * folder it should be.
258 *
259 * If this option confuses you, just set it to 'true'. You can not hurt
260 * anything if it's true, but some servers will respond weird if it's
261 * false. (Cyrus works fine whether it's true OR false).
262 */
263 $show_contain_subfolders_option = false;
264
265 /**
266 * These next two options set the defaults for the way that the
267 * users see their folder list.
268 * $default_unseen_notify
269 * Specifies whether or not the users will see the number of
270 * unseen in each folder by default and also which folders to
271 * do this to. Valid values are: 1=none, 2=inbox, 3=all.
272 * $default_unseen_type
273 * Specifies the type of notification to give the users by
274 * default. Valid choice are: 1=(4), 2=(4,25).
275 */
276 $default_unseen_notify = 2;
277 $default_unseen_type = 1;
278
279 /**
280 * This enables the no select fix for Cyrus when subfolders
281 * exist but parent folders do not
282 */
283 $noselect_fix_enable = false;
284
285 /*** General options ***/
286 /**
287 * Path to the data/ directory
288 * It is a possible security hole to have a writable directory
289 * under the web server's root directory (ex: /home/httpd/html).
290 * For this reason, it is possible to put the data directory
291 * anywhere you would like. The path name can be absolute or
292 * relative (to the config directory). It doesn't matter. Here
293 * are two examples:
294 *
295 * Absolute:
296 * $data_dir = '/usr/local/squirrelmail/data/';
297 *
298 * Relative (to main SM directory):
299 * $data_dir = SM_PATH . 'data/';
300 */
301 $data_dir = SM_PATH . 'data/';
302
303 /**
304 * Path to directory used for storing attachments while a mail is
305 * being sent. There are a few security considerations regarding
306 * this directory:
307 * + It should have the permission 733 (rwx-wx-wx) to make it
308 * impossible for a random person with access to the webserver to
309 * list files in this directory. Confidential data might be laying
310 * around there.
311 * + Since the webserver is not able to list the files in the content
312 * is also impossible for the webserver to delete files lying around
313 * there for too long.
314 * + It should probably be another directory than data_dir.
315 */
316 $attachment_dir = $data_dir;
317
318 /**
319 * Hash level used for data directory.
320 *
321 * This option allows spliting file based squirrelmail user
322 * data storage directory into several subfolders. Number from
323 * 0 to 4 allows allows having up to four subfolder levels.
324 *
325 * Hashing should speed up directory access if you have big number
326 * of users (500 and more).
327 */
328 $dir_hash_level = 0;
329
330 /**
331 * This is the default size of the folder list. Default
332 * is 150, but you can set it to whatever you wish.
333 */
334 $default_left_size = '150';
335
336 /**
337 * Some IMAP servers allow a username (like 'bob') to log in if they use
338 * uppercase in their name (like 'Bob' or 'BOB'). This creates extra
339 * preference files. Toggling this option to true will transparently
340 * change all usernames to lowercase.
341 */
342 $force_username_lowercase = false;
343
344 /**
345 * This option enables use of email priority flags by end users.
346 */
347 $default_use_priority = true;
348
349 /**
350 * This option disables display of "created by squirrelmail developers"
351 * strings and provider link
352 */
353 $hide_sm_attributions = false;
354
355 /**
356 * This option enables use of read/delivery reciepts by end users.
357 */
358 $default_use_mdn = true;
359
360 /**
361 * If you don't want to allow users to change their email address
362 * then you can set $edit_identity to false, if you want them to
363 * not be able to change their full name too then set $edit_name
364 * to false as well. $edit_name has no effect unless $edit_identity
365 * is false;
366 */
367 $edit_identity = true;
368 $edit_name = true;
369
370 /**
371 * If you want to enable server side thread sorting options
372 * Your IMAP server must support the THREAD extension for
373 * this to work.
374 */
375 $allow_thread_sort = false;
376
377 /**
378 * to use server-side sorting instead of SM client side.
379 * Your IMAP server must support the SORT extension for this
380 * to work.
381 */
382 $allow_server_sort = false;
383
384 /**
385 * This option allows you to choose if SM uses charset search
386 * Your imap server should support SEARCH CHARSET command for
387 * this to work.
388 */
389 $allow_charset_search = true;
390
391 /**
392 * PHP session name. Leave this alone unless you know what you are doing.
393 */
394 $session_name = 'SQMSESSID';
395
396
397 /**
398 * Themes
399 * You can define your own theme and put it in this directory.
400 * You must call it as the example below. You can name the theme
401 * whatever you want. For an example of a theme, see the ones
402 * included in the config directory.
403 *
404 * To add a new theme to the options that users can choose from, just
405 * add a new number to the array at the bottom, and follow the pattern.
406 *
407 * $theme_default sets theme that will be used by default
408 * $theme_css sets stylesheet (from theme/css directory) that will be
409 * used by default.
410 */
411 $theme_default = 0;
412 $theme_css = '';
413
414 $theme[0]['PATH'] = SM_PATH . 'themes/default_theme.php';
415 $theme[0]['NAME'] = 'Default';
416
417 $theme[1]['PATH'] = SM_PATH . 'themes/plain_blue_theme.php';
418 $theme[1]['NAME'] = 'Plain Blue';
419
420 $theme[2]['PATH'] = SM_PATH . 'themes/sandstorm_theme.php';
421 $theme[2]['NAME'] = 'Sand Storm';
422
423 $theme[3]['PATH'] = SM_PATH . 'themes/deepocean_theme.php';
424 $theme[3]['NAME'] = 'Deep Ocean';
425
426 $theme[4]['PATH'] = SM_PATH . 'themes/slashdot_theme.php';
427 $theme[4]['NAME'] = 'Slashdot';
428
429 $theme[5]['PATH'] = SM_PATH . 'themes/purple_theme.php';
430 $theme[5]['NAME'] = 'Purple';
431
432 $theme[6]['PATH'] = SM_PATH . 'themes/forest_theme.php';
433 $theme[6]['NAME'] = 'Forest';
434
435 $theme[7]['PATH'] = SM_PATH . 'themes/ice_theme.php';
436 $theme[7]['NAME'] = 'Ice';
437
438 $theme[8]['PATH'] = SM_PATH . 'themes/seaspray_theme.php';
439 $theme[8]['NAME'] = 'Sea Spray';
440
441 $theme[9]['PATH'] = SM_PATH . 'themes/bluesteel_theme.php';
442 $theme[9]['NAME'] = 'Blue Steel';
443
444 $theme[10]['PATH'] = SM_PATH . 'themes/dark_grey_theme.php';
445 $theme[10]['NAME'] = 'Dark Grey';
446
447 $theme[11]['PATH'] = SM_PATH . 'themes/high_contrast_theme.php';
448 $theme[11]['NAME'] = 'High Contrast';
449
450 $theme[12]['PATH'] = SM_PATH . 'themes/black_bean_burrito_theme.php';
451 $theme[12]['NAME'] = 'Black Bean Burrito';
452
453 $theme[13]['PATH'] = SM_PATH . 'themes/servery_theme.php';
454 $theme[13]['NAME'] = 'Servery';
455
456 $theme[14]['PATH'] = SM_PATH . 'themes/maize_theme.php';
457 $theme[14]['NAME'] = 'Maize';
458
459 $theme[15]['PATH'] = SM_PATH . 'themes/bluesnews_theme.php';
460 $theme[15]['NAME'] = 'BluesNews';
461
462 $theme[16]['PATH'] = SM_PATH . 'themes/deepocean2_theme.php';
463 $theme[16]['NAME'] = 'Deep Ocean 2';
464
465 $theme[17]['PATH'] = SM_PATH . 'themes/blue_grey_theme.php';
466 $theme[17]['NAME'] = 'Blue Grey';
467
468 $theme[18]['PATH'] = SM_PATH . 'themes/dompie_theme.php';
469 $theme[18]['NAME'] = 'Dompie';
470
471 $theme[19]['PATH'] = SM_PATH . 'themes/methodical_theme.php';
472 $theme[19]['NAME'] = 'Methodical';
473
474 $theme[20]['PATH'] = SM_PATH . 'themes/greenhouse_effect.php';
475 $theme[20]['NAME'] = 'Greenhouse Effect (Changes)';
476
477 $theme[21]['PATH'] = SM_PATH . 'themes/in_the_pink.php';
478 $theme[21]['NAME'] = 'In The Pink (Changes)';
479
480 $theme[22]['PATH'] = SM_PATH . 'themes/kind_of_blue.php';
481 $theme[22]['NAME'] = 'Kind of Blue (Changes)';
482
483 $theme[23]['PATH'] = SM_PATH . 'themes/monostochastic.php';
484 $theme[23]['NAME'] = 'Monostochastic (Changes)';
485
486 $theme[24]['PATH'] = SM_PATH . 'themes/shades_of_grey.php';
487 $theme[24]['NAME'] = 'Shades of Grey (Changes)';
488
489 $theme[25]['PATH'] = SM_PATH . 'themes/spice_of_life.php';
490 $theme[25]['NAME'] = 'Spice of Life (Changes)';
491
492 $theme[26]['PATH'] = SM_PATH . 'themes/spice_of_life_lite.php';
493 $theme[26]['NAME'] = 'Spice of Life - Lite (Changes)';
494
495 $theme[27]['PATH'] = SM_PATH . 'themes/spice_of_life_dark.php';
496 $theme[27]['NAME'] = 'Spice of Life - Dark (Changes)';
497
498 $theme[28]['PATH'] = SM_PATH . 'themes/christmas.php';
499 $theme[28]['NAME'] = 'Holiday - Christmas';
500
501 $theme[29]['PATH'] = SM_PATH . 'themes/darkness.php';
502 $theme[29]['NAME'] = 'Darkness (Changes)';
503
504 $theme[30]['PATH'] = SM_PATH . 'themes/random.php';
505 $theme[30]['NAME'] = 'Random (Changes every login)';
506
507 $theme[31]['PATH'] = SM_PATH . 'themes/midnight.php';
508 $theme[31]['NAME'] = 'Midnight';
509
510 $theme[32]['PATH'] = SM_PATH . 'themes/alien_glow.php';
511 $theme[32]['NAME'] = 'Alien Glow';
512
513 $theme[33]['PATH'] = SM_PATH . 'themes/dark_green.php';
514 $theme[33]['NAME'] = 'Dark Green';
515
516 $theme[34]['PATH'] = SM_PATH . 'themes/penguin.php';
517 $theme[34]['NAME'] = 'Penguin';
518
519 $theme[35]['PATH'] = SM_PATH . 'themes/minimal_bw.php';
520 $theme[35]['NAME'] = 'Minimal BW';
521
522
523 /**
524 * LDAP server(s)
525 * Array of arrays with LDAP server parameters. See
526 * functions/abook_ldap_server.php for a list of possible
527 * parameters
528 *
529 * EXAMPLE:
530 * $ldap_server[0] = Array(
531 * 'host' => 'memberdir.netscape.com',
532 * 'name' => 'Netcenter Member Directory',
533 * 'base' => 'ou=member_directory,o=netcenter.com'
534 * );
535 */
536 // Add your ldap server options here
537
538 /**
539 * Users may search their addressbook via either a plain HTML or Javascript
540 * enhanced user interface. This option allows you to set the default choice.
541 * Set this default choice as either:
542 * true = javascript
543 * false = html
544 */
545 $default_use_javascript_addr_book = false;
546
547
548 /**
549 * MOTD
550 * This is a message that is displayed immediately after a user logs in.
551 */
552 $motd = "";
553
554
555 /**
556 * To install plugins, just add elements to this array that have
557 * the plugin directory name relative to the /plugins/ directory.
558 * For instance, for the 'sqclock' plugin, you'd put a line like
559 * the following.
560 * $plugins[0] = 'sqclock';
561 * $plugins[1] = 'attachment_common';
562 */
563 // Add list of enabled plugins here
564
565
566 /*** Database ***/
567 /**
568 * Read doc/database.txt in order to get more information
569 * about these settings.
570 */
571 /**
572 * Database-driven private addressbooks
573 * DSN (Data Source Name) for a database where the private
574 * addressbooks are stored. See doc/db-backend.txt for more info.
575 * If it is not set, the addressbooks are stored in files
576 * in the data dir.
577 * The DSN is in the format: mysql://user:pass@hostname/dbname
578 * The table is the name of the table to use within the
579 * specified database.
580 */
581 $addrbook_dsn = '';
582 $addrbook_table = 'address';
583 /**
584 * Database used to store user data
585 */
586 $prefs_dsn = '';
587 $prefs_table = 'userprefs';
588 $prefs_key_field = 'prefkey';
589 $prefs_user_field = 'user';
590 $prefs_val_field = 'prefval';
591 /**
592 * Global sql database options
593 */
594 $addrbook_global_dsn = '';
595 $addrbook_global_table = 'global_abook';
596 $addrbook_global_writeable = false;
597 $addrbook_global_listing = false;
598
599 /*** Language settings ***/
600 /**
601 * Default language
602 * This is the default language. It is used as a last resort
603 * if SquirrelMail can't figure out which language to display.
604 * Language names usually consist of language code, undercore
605 * symbol and country code
606 */
607 $squirrelmail_default_language = 'en_US';
608
609 /**
610 * This option controls what character set is used when sending mail
611 * and when sending HTML to the browser. Do not set this to US-ASCII,
612 * use ISO-8859-1 instead.
613 *
614 * You can set this option, only if $squirrelmail_default_language setting
615 * contains 'en_US' string. In any other case system does not allow
616 * making mistakes with incorrect language and charset combinations.
617 */
618 $default_charset = 'iso-8859-1';
619
620 /**
621 * This option controls number of languages available to end user in
622 * language selection preferences. You can use space separated list
623 * of translations installed in locale/ directory or special keys
624 * 'all' (all languages are available) and 'none' (language selection
625 * is disabled, interface is set to $squirrelmail_default_language
626 */
627 $available_languages = 'all';
628
629 /**
630 * This options allows displaying native language names in language
631 * selection box.
632 */
633 $show_alternative_names = false;
634
635 /**
636 * This option enables reading of Eastern multibyte encodings.
637 * Functions that provide this support are very cpu and memory intensive.
638 * Don't enable this option unless you really need it.
639 */
640 $agresive_decoding = false;
641
642 /*** Tweaks ***/
643 /**
644 * Use experimental DHTML folder listing
645 */
646 $advanced_tree = false;
647 /**
648 * Use older way of folder listing
649 */
650 $oldway = false;
651 /**
652 * Use experimental code with php recode functions when reading messages with
653 * different encoding. This code is faster that original SM functions,
654 * but it require php with recode support.
655 *
656 * Don't enable this option if you are not sure about availability of
657 * recode support.
658 */
659 $use_php_recode = false;
660 /**
661 * Use experimental code with php iconv functions when reading messages with
662 * different encoding. This code is faster that original SM functions,
663 * but it require php with iconv support and works only with some translations.
664 *
665 * Don't enable this option if you are not sure about availability of
666 * iconv support.
667 */
668 $use_php_iconv = false;
669
670 /**
671 * this disables listing all of the folders on the IMAP Server to
672 * generate the folder subscribe listbox (this can take a long time
673 * when you have a lot of folders). Instead, a textbox will be
674 * displayed allowing users to enter a specific folder name to subscribe to
675 *
676 * This option can't be changed by conf.pl
677 */
678 $no_list_for_subscribe = false;
679
680 /**
681 * This option is used only by conf.pl script to generate configuration
682 * menu with some colors and is provided here only as reference.
683 */
684 $config_use_color = 2;
685
686 /**
687 * This option includes special configuration options
688 */
689 @include SM_PATH . 'config/config_local.php';
690
691 /**
692 * Make sure there are no characters after the PHP closing
693 * tag below (including newline characters and whitespace).
694 * Otherwise, that character will cause the headers to be
695 * sent and regular output to begin, which will majorly screw
696 * things up when we try to send more headers later.
697 */
698 ?>