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