Standardize syntax
[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 * Note on SECURITY: some options require putting a password in this file.
14 * Please make sure that you adapt its permissions appropriately to avoid
15 * passwords being leaked to e.g. other system users. Take extra care when
16 * the webserver is shared with untrusted users.
17 *
18 * @copyright &copy; 2000-2007 The SquirrelMail Project Team
19 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
20 * @version $Id$
21 * @package squirrelmail
22 * @subpackage config
23 */
24
25 /* Do not change this value. */
26 global $config_version;
27 $config_version = '1.5.0';
28
29 /*** Organization preferences ***/
30 /**
31 * Organization's name
32 * @global string $org_name
33 */
34 $org_name = "SquirrelMail";
35
36 /**
37 * Organization's logo picture (blank if none)
38 * @global string $org_logo
39 */
40 $org_logo = SM_PATH . 'images/sm_logo.png';
41
42 /**
43 * The width of the logo (0 for default)
44 * @global string $org_logo_width
45 */
46 $org_logo_width = '308';
47
48 /**
49 * The height of the logo (0 for default)
50 * @global string $org_logo_height
51 */
52 $org_logo_height = '111';
53
54 /**
55 * Webmail Title
56 *
57 * This is the web page title that appears at the top of the browser window.
58 * @global string $org_title
59 */
60 $org_title = "SquirrelMail";
61
62 /**
63 * Signout page
64 *
65 * Rather than going to the signout.php page (which only allows you
66 * to sign back in), setting signout_page allows you to sign the user
67 * out and then redirect to whatever page you want. For instance,
68 * the following would return the user to your home page:
69 * $signout_page = '/';
70 * Set to the empty string to continue to use the default signout page.
71 * @global string $signout_page
72 */
73 $signout_page = '';
74
75 /**
76 * Top frame
77 *
78 * By default SquirrelMail takes up the whole browser window,
79 * this allows you to embed it within sites using frames. Set
80 * this to the frame you want it to stay in.
81 * @global string $frame_top
82 */
83 $frame_top = '_top';
84
85 /**
86 * Provider name
87 *
88 * Here you can set the text of the link displayed on the top-right
89 * of the message list.
90 *
91 * Defaults to empty (no link).
92 *
93 * @global string $provider_name
94 */
95 $provider_name = '';
96
97 /**
98 * Provider URI
99 *
100 * Here you can set URL of the link displayed on the top-right of
101 * the message list.
102 *
103 * Defaults to empty (no link).
104 *
105 * @global string $provider_uri
106 */
107 $provider_uri = '';
108
109 /*** Server Settings ***/
110 /**
111 * Default Domain
112 *
113 * The domain part of local email addresses.
114 * This is for all messages sent out from this server.
115 * Reply address is generated by $username@$domain
116 * Example: In bob@example.com, example.com is the domain.
117 * @global string $domain
118 */
119 $domain = 'example.com';
120
121 /**
122 * Time offset inversion
123 *
124 * If you are running on a machine that doesn't have the tm_gmtoff
125 * value in your time structure and if you are in a time zone that
126 * has a negative offset, you need to set this value to 1. This is
127 * typically people in the US that are running Solaris 7.
128 * @global bool $invert_time
129 */
130 $invert_time = false;
131
132 /**
133 * Default send transport
134 *
135 * What should be used when sending email.
136 * If it is set to false, SquirrelMail will use SMTP server settings.
137 * If it is set to true, SquirrelMail will use program defined in
138 * $sendmail_path
139 * @global bool $useSendmail
140 */
141 $useSendmail = false;
142
143 /**
144 * Your SMTP server (usually the same as the IMAP server).
145 * @global string $smtpServerAddress
146 */
147 $smtpServerAddress = 'localhost';
148 /**
149 * Your SMTP port number (usually 25).
150 * @global integer $smtpPort
151 */
152 $smtpPort = 25;
153
154 /**
155 * SquirrelMail header encryption
156 *
157 * Encryption key allows to hide SquirrelMail Received: headers
158 * in outbound messages. Interface uses encryption key to encode
159 * username, remote address and proxied address, then stores encoded
160 * information in X-Squirrel-* headers.
161 *
162 * Warning: used encryption function is not bulletproof. When used
163 * with static encryption keys, it provides only minimal security
164 * measures and information can be decoded quickly.
165 *
166 * Encoded information can be decoded with decrypt_headers.php script
167 * from SquirrelMail contrib/ directory.
168 * @global string $encode_header_key
169 * @since 1.5.1 and 1.4.5
170 */
171 $encode_header_key = '';
172
173 /**
174 * Path to Sendmail
175 *
176 * Program that should be used when sending email. SquirrelMail expects that
177 * this program will follow options used by original sendmail
178 * (http://www.sendmail.org). Support of -f argument is required.
179 * @global string $sendmail_path
180 */
181 $sendmail_path = '/usr/sbin/sendmail';
182
183 /**
184 * Extra sendmail command arguments.
185 *
186 * Sets additional sendmail command arguments. Make sure that arguments are
187 * supported by your sendmail program. -f argument is added automatically by
188 * SquirrelMail scripts. Variable defaults to standard /usr/sbin/sendmail
189 * arguments. If you use qmail-inject, nbsmtp or any other sendmail wrapper,
190 * which does not support -t and -i arguments, set variable to empty string
191 * or use arguments suitable for your mailer.
192 * @global string $sendmail_args
193 * @since 1.5.1 and 1.4.8
194 */
195 $sendmail_args = '-i -t';
196
197 /**
198 * IMAP server address
199 *
200 * The dns name (or IP address) for your imap server.
201 * @global string $imapServerAddress
202 */
203 $imapServerAddress = 'localhost';
204
205 /**
206 * IMAP server port
207 *
208 * Port used by your imap server. (Usually 143)
209 * @global integer $imapPort
210 */
211 $imapPort = 143;
212
213 /**
214 * IMAP server type
215 *
216 * The type of IMAP server you are running.
217 * Valid type are the following (case is important):
218 * bincimap
219 * courier
220 * cyrus
221 * dovecot
222 * exchange
223 * hmailserver
224 * macosx
225 * mercury32
226 * uw
227 * other
228 *
229 * Please note that this changes only some of server settings.
230 *
231 * In order to set everything correctly, you need to adjust several
232 * SquirrelMail options. These options are listed in doc/presets.txt
233 * @global string $imap_server_type
234 */
235 $imap_server_type = 'other';
236
237 /**
238 * Secure IMAP connection controls
239 *
240 * 0 - use plain text connection,
241 * 1 - use imaps (adds tls:// prefix to hostname),
242 * 2 - use IMAP STARTTLS extension (rfc2595).
243 *
244 * Was boolean before 1.5.1.
245 * @global integer $use_imap_tls
246 * @since 1.4.0
247 */
248 $use_imap_tls = 0;
249
250 /**
251 * Secure SMTP connection controls
252 *
253 * 0 - use plain text connection,
254 * 1 - use ssmtp (adds tls:// prefix to hostname),
255 * 2 - use SMTP STARTTLS extension (rfc2487).
256 *
257 * Was boolean before 1.5.1.
258 * @global integer $use_smtp_tls
259 * @since 1.4.0
260 */
261 $use_smtp_tls = 0;
262
263 /**
264 * SMTP authentication mechanism
265 *
266 * auth_mech can be either 'none', 'login','plain', 'cram-md5', or 'digest-md5'
267 * @global string $smtp_auth_mech
268 */
269 $smtp_auth_mech = 'none';
270
271 /**
272 * Custom SMTP authentication username
273 *
274 * IMAP username is used if variable is set to empty string.
275 * Variable is included in main configuration file only from 1.5.2 version.
276 * Older versions stored it in config_local.php.
277 * @global string $smtp_sitewide_user
278 * @since 1.5.0
279 */
280 $smtp_sitewide_user = '';
281
282 /**
283 * Custom SMTP authentication password
284 *
285 * IMAP password is used if $smtp_sitewide_user global is set to empty string.
286 * Variable is included in main configuration file only from 1.5.2 version.
287 * Older versions stored it in config_local.php.
288 * @global string $smtp_sitewide_pass
289 * @since 1.5.0
290 */
291 $smtp_sitewide_pass = '';
292
293 /**
294 * IMAP authentication mechanism
295 *
296 * auth_mech can be either 'login','plain', 'cram-md5', or 'digest-md5'
297 * @global string $imap_auth_mech
298 */
299 $imap_auth_mech = 'login';
300
301 /**
302 * IMAP folder delimiter
303 *
304 * This is the delimiter that your IMAP server uses to distinguish between
305 * folders. For example, Cyrus uses '.' as the delimiter and a complete
306 * folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would
307 * look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect'
308 * but if you are sure you know what delimiter your server uses, you can
309 * specify it here.
310 *
311 * To have it autodetect the delimiter, set it to 'detect'.
312 * @global string $optional_delimiter
313 */
314 $optional_delimiter = 'detect';
315
316 /**
317 * POP before SMTP setting
318 *
319 * Do you wish to use POP3 before SMTP? Your server must
320 * support this in order for SquirrelMail to work with it.
321 * @global bool $pop_before_smtp
322 */
323 $pop_before_smtp = false;
324
325
326 /*** Folder Settings ***/
327 /**
328 * Default IMAP folder prefix
329 *
330 * Many servers store mail in your home directory. With this, they
331 * store them in a subdirectory: mail/ or Mail/, etc. If your server
332 * does this, please set this to what the default mail folder should
333 * be. This is still a user preference, so they can change it if it
334 * is different for each user.
335 *
336 * Example:
337 * $default_folder_prefix = 'mail/';
338 * -- or --
339 * $default_folder_prefix = 'Mail/folders/';
340 *
341 * If you do not use this, set it to the empty string.
342 * @global string $default_folder_prefix
343 */
344 $default_folder_prefix = '';
345
346 /**
347 * User level prefix control
348 *
349 * If you do not wish to give them the option to change this, set it
350 * to false. Otherwise, if it is true, they can change the folder prefix
351 * to be anything.
352 * @global bool $show_prefix_option
353 */
354 $show_prefix_option = false;
355
356 /**
357 * The following are related to deleting messages.
358 * $default_move_to_trash
359 * If this is set to 'true', when 'delete' is pressed, it
360 * will attempt to move the selected messages to the folder
361 * named $trash_folder. If it's set to 'false', we won't even
362 * attempt to move the messages, just delete them.
363 * $default_move_to_sent
364 * If this is set to 'true', sent messages will be stored in
365 * $sent_folder by default.
366 * $default_save_as_draft
367 * If this is set to 'true', users are able to use $draft_folder
368 * to store their unfinished messages.
369 * $trash_folder
370 * This is the path to the default trash folder. For Cyrus
371 * IMAP, it would be 'INBOX.Trash', but for UW it would be
372 * 'Trash'. We need the full path name here.
373 * $draft_folder
374 * This is the patch to where Draft messages will be stored.
375 * $auto_expunge
376 * If this is true, when a message is moved or copied, the
377 * source mailbox will get expunged, removing all messages
378 * marked 'Deleted'.
379 * $sent_folder
380 * This is the path to where Sent messages will be stored.
381 * $delete_folder
382 * If this is true, when a folder is deleted then it will
383 * not get moved into the Trash folder.
384 * @global bool $default_move_to_trash
385 * @global bool $default_move_to_sent
386 * @global bool $default_save_as_draft
387 * @global string $trash_folder
388 * @global string $sent_folder
389 * @global string $draft_folder
390 * @global bool $auto_expunge
391 * @global bool $delete_folder
392 */
393 $default_move_to_trash = true;
394 $default_move_to_sent = true;
395 $default_save_as_draft = true;
396 $trash_folder = 'INBOX.Trash';
397 $sent_folder = 'INBOX.Sent';
398 $draft_folder = 'INBOX.Drafts';
399 $auto_expunge = true;
400 $delete_folder = false;
401
402 /**
403 * Special Folder Color Control
404 *
405 * Whether or not to use a special color for special folders. If not,
406 * special folders will be the same color as the other folders.
407 * @global bool $use_special_folder_color
408 */
409 $use_special_folder_color = true;
410
411 /**
412 * Create Special Folders Control
413 *
414 * Should I create the Sent and Trash folders automatically for
415 * a new user that doesn't already have them created?
416 * @global bool $auto_create_special
417 */
418 $auto_create_special = true;
419
420 /**
421 * List Special Folders First Control
422 *
423 * Whether or not to list the special folders first (true/false).
424 * @global bool $list_special_folders_first
425 */
426 $list_special_folders_first = true;
427
428 /**
429 * Subfolder Layout Control
430 *
431 * Are all your folders subfolders of INBOX (i.e. cyrus IMAP server).
432 * If you are unsure, set it to false.
433 * @global bool $default_sub_of_inbox
434 */
435 $default_sub_of_inbox = true;
436
437 /**
438 * Subfolder Format Control
439 *
440 * Some IMAP daemons (UW) handle folders weird. They only allow a
441 * folder to contain either messages or other folders, not both at
442 * the same time. This option controls whether or not to display an
443 * option during folder creation. The option toggles which type of
444 * folder it should be.
445 *
446 * If this option confuses you, just set it to 'true'. You can not hurt
447 * anything if it's true, but some servers will respond weird if it's
448 * false. (Cyrus works fine whether it's true OR false).
449 * @global bool $show_contain_subfolders_option
450 */
451 $show_contain_subfolders_option = false;
452
453 /**
454 * These next two options set the defaults for the way that the
455 * users see their folder list.
456 * $default_unseen_notify
457 * Specifies whether or not the users will see the number of
458 * unseen in each folder by default and also which folders to
459 * do this to. Valid values are: 1=none, 2=inbox, 3=all.
460 * $default_unseen_type
461 * Specifies the type of notification to give the users by
462 * default. Valid choice are: 1=(4), 2=(4,25).
463 * @global integer $default_unseen_notify
464 * @global integer $default_unseen_type
465 */
466 $default_unseen_notify = 2;
467 $default_unseen_type = 1;
468
469 /**
470 * NoSelect Fix Control
471 *
472 * This enables the no select fix for Cyrus when subfolders
473 * exist but parent folders do not
474 * @global bool $noselect_fix_enable
475 */
476 $noselect_fix_enable = false;
477
478 /*** General options ***/
479 /**
480 * Path to the data/ directory
481 *
482 * You need to create this directory yourself (see INSTALL).
483 *
484 * It is a possible security hole to have a writable directory
485 * under the web server's root directory (ex: /home/httpd/html).
486 * The path name can be absolute or relative (to the config directory).
487 * If path is relative, it must use SM_PATH constant.
488 * Here are two examples:
489 *
490 * Absolute:
491 * $data_dir = '/var/local/squirrelmail/data/';
492 *
493 * Relative (to main SM directory):
494 * $data_dir = SM_PATH . 'data/';
495 * (NOT recommended: you need to secure apache to make sure these
496 * files are not world readable)
497 *
498 * @global string $data_dir
499 */
500 $data_dir = '/var/local/squirrelmail/data/';
501
502 /**
503 * Attachments directory
504 *
505 * Path to directory used for storing attachments while a mail is
506 * being sent. There are a few security considerations regarding
507 * this directory:
508 * + It should have the permission 733 (rwx-wx-wx) to make it
509 * impossible for a random person with access to the webserver to
510 * list files in this directory. Confidential data might be laying
511 * around there.
512 * + Since the webserver is not able to list the files in the content
513 * is also impossible for the webserver to delete files lying around
514 * there for too long. You should have some script that deletes
515 * left over temp files.
516 * + It should probably be another directory than data_dir.
517 * @global string $attachment_dir
518 */
519 $attachment_dir = '/var/local/squirrelmail/attach/';
520
521 /**
522 * Hash level used for data directory.
523 *
524 * This option allows spliting file based SquirrelMail user
525 * data storage directory into several subfolders. Number from
526 * 0 to 4 allows allows having up to four subfolder levels.
527 *
528 * Hashing should speed up directory access if you have big number
529 * of users (500 and more).
530 * @global integer $dir_hash_level
531 */
532 $dir_hash_level = 0;
533
534 /**
535 * Default Size of Folder List
536 *
537 * This is the default size of the folder list. Default
538 * is 150, but you can set it to whatever you wish.
539 * @global string $default_left_size
540 */
541 $default_left_size = '150';
542
543 /**
544 * Username Case Control
545 *
546 * Some IMAP servers allow a username (like 'bob') to log in if they use
547 * uppercase in their name (like 'Bob' or 'BOB'). This creates extra
548 * preference files. Toggling this option to true will transparently
549 * change all usernames to lowercase.
550 * @global bool $force_username_lowercase
551 */
552 $force_username_lowercase = false;
553
554 /**
555 * Email Priority Control
556 *
557 * This option enables use of email priority flags by end users.
558 * @global bool $default_use_priority
559 */
560 $default_use_priority = true;
561
562 /**
563 * SquirrelMail Attributions Control
564 *
565 * This option disables display of "created by SquirrelMail developers"
566 * strings and links.
567 * @global bool $hide_sm_attributions
568 * @since 1.2.0
569 */
570 $hide_sm_attributions = false;
571
572 /**
573 * Delivery Receipts Control
574 *
575 * This option enables use of read/delivery receipts by end users.
576 * @global bool $default_use_mdn
577 */
578 $default_use_mdn = true;
579
580 /**
581 * Identity Controls
582 *
583 * If you don't want to allow users to change their email address
584 * then you can set $edit_identity to false, if you want them to
585 * not be able to change their full name too then set $edit_name
586 * to false as well. $edit_name has no effect unless $edit_identity
587 * is false;
588 * @global bool $edit_identity
589 * @global bool $edit_name
590 */
591 $edit_identity = true;
592 $edit_name = true;
593
594 /**
595 * SquirrelMail adds username information to every sent email.
596 * It is done in order to prevent possible sender forging when
597 * end users are allowed to change their email and name
598 * information.
599 *
600 * You can disable this header, if you think that it violates
601 * user's privacy or security. Please note, that setting will
602 * work only when users are not allowed to change their identity.
603 *
604 * See SquirrelMail bug tracker #847107 for more details about it.
605 * @global bool $hide_auth_header
606 * @since 1.5.1 and 1.4.5
607 */
608 $hide_auth_header = false;
609
610 /**
611 * Server Side Threading Control
612 *
613 * Set it to true, if you want to disable server side thread
614 * sorting options. Your IMAP server must support the THREAD
615 * extension for this to have any effect.
616 *
617 * Older SquirrelMail versions used $allow_thread_sort option.
618 * @global bool $disable_thread_sort
619 * @since 1.5.1
620 */
621 $disable_thread_sort = false;
622
623 /**
624 * Server Side Sorting Control
625 *
626 * Set it to true, if you want to disable server side sorting
627 * and use SM client side sorting instead (client side sorting
628 * can be slow). Your IMAP server must support the SORT extension
629 * for this to have any effect.
630 *
631 * Older SquirrelMail versions used $allow_server_sort option.
632 * @global bool $disable_server_sort
633 * @since 1.5.1
634 */
635 $disable_server_sort = false;
636
637 /**
638 * IMAP Charset Use Control
639 *
640 * This option allows you to choose if SM uses charset search
641 * Your imap server should support SEARCH CHARSET command for
642 * this to work.
643 * @global bool $allow_charset_search
644 */
645 $allow_charset_search = true;
646
647 /**
648 * Search functions control
649 *
650 * This option allows you to control the use of advanced search form.
651 * Set to 0 to enable basic search only, 1 to enable advanced search only
652 * or 2 to enable both.
653 * @global integer $allow_advanced_search
654 */
655 $allow_advanced_search = 0;
656
657 /**
658 * PHP session name.
659 *
660 * Leave this alone unless you know what you are doing.
661 * @global string $session_name
662 */
663 $session_name = 'SQMSESSID';
664
665
666 /**
667 * User Themes
668 * You can define your own theme and put it in directory in SM_PATH/css/.
669 * You must call it as the example below. You can name the theme
670 * whatever you want.
671 *
672 * To add a new theme to the options that users can choose from, just
673 * add a new number to the array at the bottom, and follow the pattern.
674 *
675 * $user_theme_default sets theme that will be used by default
676 *
677 * @global integer $user_theme_default
678 * @since 1.5.2
679 */
680 $user_theme_default = 0;
681
682 /**
683 * Listing of installed themes
684 * @global array $user_themes
685 * @since 1.5.2
686 */
687 $user_themes[0]['PATH'] = 'none';
688 $user_themes[0]['NAME'] = 'Default';
689
690 $user_themes[1]['PATH'] = '../css/blue_gradient/';
691 $user_themes[1]['NAME'] = 'Blue Options';
692
693 /**
694 * Message Icons control
695 *
696 * Use icons for message and folder markers
697 * @global bool $use_icons
698 * @since 1.5.1
699 */
700 $use_icons = true;
701
702 /**
703 * Icon Themes
704 * You can create your own icon themes and put them in a directory in
705 * SM_PATH/images/themes/. Your users will be able to choose whatever
706 * icon themes are listed below.
707 *
708 * To add a new theme to the list of available icon themes, just add a new
709 * number to the array below and follow the pattern
710 *
711 * $icon_theme_default sets the theme that will be used by default.
712 * $icon_theme_fallback specifies which theme will be used if an icon is
713 * not found in the selected theme
714 *
715 * @global integer $icon_theme_def
716 * @global integer $icon_theme_fallback
717 * @since 1.5.2
718 */
719 $icon_theme_def = 1;
720 $icon_theme_fallback = 3;
721
722 /**
723 * Listing of installed icon themes
724 * @global array $icon_themes
725 * @since 1.5.2
726 */
727 $icon_themes[0]['PATH'] = 'none';
728 $icon_themes[0]['NAME'] = 'No Icons';
729
730 $icon_themes[1]['PATH'] = 'template';
731 $icon_themes[1]['NAME'] = 'Template Default Icons';
732
733 $icon_themes[2]['PATH'] = '../images/themes/default/';
734 $icon_themes[2]['NAME'] = 'Default Icon Set';
735
736 $icon_themes[3]['PATH'] = '../images/themes/xp/';
737 $icon_themes[3]['NAME'] = 'XP Style Icons';
738
739 /**
740 * Templates
741 * You can define your own template set (skin) and put it in a new
742 * directory under SM_PATH/templates. The ID must match the name of
743 * the template directory as the example below. You can name the
744 * template whatever you want. For an example of a template, see
745 * the ones included in the SM_PATH/templates directory.
746 *
747 * To add a new template to the options that users can choose from, just
748 * add a new number to the array at the bottom, and follow the pattern.
749 *
750 * $templateset_default sets the skin that will be used by default
751 * when a user doesn't have a skin selection
752 * in their preferences. (Must be the "ID" of
753 * the desired template set)
754 *
755 * $templateset_fallback tells SquirrelMail which template set (skin)
756 * to use when looking for a file that is not
757 * contained within whatever skin is currently
758 * being used. (Must be the "ID" of the desired
759 * template set)
760 *
761 * @global string $templateset_default
762 * @global string $templateset_fallback
763 */
764 $templateset_default = 'default';
765 $templateset_fallback = 'default';
766
767 $aTemplateSet[0]['ID'] = 'default';
768 $aTemplateSet[0]['NAME'] = 'Default';
769 $aTemplateSet[1]['ID'] = 'default_advanced';
770 $aTemplateSet[1]['NAME'] = 'Advanced';
771
772 /**
773 * Default interface font size.
774 * @global string $default_fontsize
775 * @since 1.5.1
776 */
777 $default_fontsize = '';
778
779 /**
780 * Default font set
781 * @global string $default_fontset
782 * @since 1.5.1
783 */
784 $default_fontset = '';
785
786 /**
787 * List of available fontsets.
788 * @global array $fontsets
789 * @since 1.5.1
790 */
791 $fontsets = array();
792 $fontsets['serif'] = 'serif';
793 $fontsets['sans'] = 'helvetica,arial,sans-serif';
794 $fontsets['comicsans'] = 'comic sans ms,sans-serif';
795 $fontsets['verasans'] = 'bitstream vera sans,verdana,sans-serif';
796 $fontsets['tahoma'] = 'tahoma,sans-serif';
797
798 /**
799 * LDAP server(s)
800 * Array of arrays with LDAP server parameters. See
801 * functions/abook_ldap_server.php for a list of possible
802 * parameters
803 *
804 * EXAMPLE:
805 * $ldap_server[0] = Array(
806 * 'host' => 'memberdir.netscape.com',
807 * 'name' => 'Netcenter Member Directory',
808 * 'base' => 'ou=member_directory,o=netcenter.com'
809 * );
810 *
811 * NOTE: please see security note at the top of this file when
812 * entering a password.
813 */
814 // Add your ldap server options here
815
816 /**
817 * Javascript in Addressbook Control
818 *
819 * Users may search their addressbook via either a plain HTML or Javascript
820 * enhanced user interface. This option allows you to set the default choice.
821 * Set this default choice as either:
822 * true = javascript
823 * false = html
824 * @global bool $default_use_javascript_addr_book
825 */
826 $default_use_javascript_addr_book = false;
827
828 /**
829 * Shared filebased address book
830 * @global string $abook_global_file
831 * @since 1.5.1 and 1.4.4
832 */
833 $abook_global_file = '';
834
835 /**
836 * Writing into shared address book control
837 * @global bool $abook_global_file_writeable
838 * @since 1.5.1 and 1.4.4
839 */
840 $abook_global_file_writeable = false;
841
842 /**
843 * Listing of shared address book control
844 * @global bool $abook_global_file_listing
845 * @since 1.5.1
846 */
847 $abook_global_file_listing = true;
848
849 /**
850 * Controls file based address book entry size
851 *
852 * This setting controls space allocated to file based address book records.
853 * End users will be unable to save address book entry, if total entry size
854 * (quoted address book fields + 4 delimiters + linefeed) exceeds allowed
855 * address book length size.
856 *
857 * Same setting is applied to personal and global file based address books.
858 *
859 * It is strongly recommended to keep default setting value. Change it only
860 * if you really want to store address book entries that are bigger than two
861 * kilobytes (2048).
862 * @global integer $abook_file_line_length
863 * @since 1.5.2
864 */
865 $abook_file_line_length = 2048;
866
867 /**
868 * MOTD
869 *
870 * This is a message that is displayed immediately after a user logs in.
871 * @global string $motd
872 */
873 $motd = "";
874
875
876 /**
877 * To install plugins, just add elements to this array that have
878 * the plugin directory name relative to the /plugins/ directory.
879 * For instance, for the 'squirrelspell' plugin, you'd put a line like
880 * the following.
881 * $plugins[] = 'squirrelspell';
882 * $plugins[] = 'listcommands';
883 */
884 // Add list of enabled plugins here
885
886
887 /**
888 * To disable all plugins regardless of any that are installed
889 * above, turn on $disable_plugins. To disable them ONLY for
890 * one user, put that username into $disable_plugins_user.
891 * @global boolean $disable_plugins
892 * @global string $disable_plugins_user
893 * @since 1.5.2
894 */
895 $disable_plugins = false;
896 $disable_plugins_user = '';
897
898
899 /*** Database ***/
900 /**
901 * Read the administrator's manual in order to get more information
902 * about these settings.
903 */
904 /**
905 * Database-driven private addressbooks
906 * DSN (Data Source Name) for a database where the private
907 * addressbooks are stored. See the administrator's manual for more info.
908 * If it is not set, the addressbooks are stored in files
909 * in the data dir.
910 * The DSN is in the format: mysql://user:pass@hostname/dbname
911 * The table is the name of the table to use within the
912 * specified database.
913 *
914 * NOTE: please see security note at the top of this file when
915 * entering a password.
916 */
917 $addrbook_dsn = '';
918 $addrbook_table = 'address';
919 /**
920 * Database used to store user data
921 */
922 $prefs_dsn = '';
923 $prefs_table = 'userprefs';
924 /**
925 * Preference key field
926 * @global string $prefs_key_field
927 */
928 $prefs_key_field = 'prefkey';
929 /**
930 * Size of preference key field
931 * @global integer $prefs_key_size
932 * @since 1.5.1
933 */
934 $prefs_key_size = 64;
935 /**
936 * Preference owner field
937 * @global string $prefs_user_field
938 */
939 $prefs_user_field = 'user';
940 /**
941 * Size of preference owner field
942 * @global integer $prefs_user_size
943 * @since 1.5.1
944 */
945 $prefs_user_size = 128;
946 /**
947 * Preference value field
948 * @global string $prefs_val_field
949 */
950 $prefs_val_field = 'prefval';
951 /**
952 * Size of preference key field
953 * @global integer $prefs_val_size
954 * @since 1.5.1
955 */
956 $prefs_val_size = 65536;
957
958 /*** Global sql database options ***/
959 /**
960 * DSN of global address book database
961 * @global string $addrbook_global_dsn
962 * @since 1.5.1 and 1.4.4
963 */
964 $addrbook_global_dsn = '';
965 /**
966 * Table used for global database address book
967 * @global string $addrbook_global_table
968 * @since 1.5.1 and 1.4.4
969 */
970 $addrbook_global_table = 'global_abook';
971 /**
972 * Control writing into global database address book
973 * @global boolean $addrbook_global_writeable
974 * @since 1.5.1 and 1.4.4
975 */
976 $addrbook_global_writeable = false;
977 /**
978 * Control listing of global database address book
979 * @global boolean $addrbook_global_listing
980 * @since 1.5.1 and 1.4.4
981 */
982 $addrbook_global_listing = false;
983
984 /*** Language settings ***/
985 /**
986 * Default language
987 *
988 * This is the default language. It is used as a last resort
989 * if SquirrelMail can't figure out which language to display.
990 * Language names usually consist of language code, undercore
991 * symbol and country code
992 * @global string $squirrelmail_default_language
993 */
994 $squirrelmail_default_language = 'en_US';
995
996 /**
997 * Default Charset
998 *
999 * This option controls what character set is used when sending
1000 * mail and when sending HTML to the browser. Option works only
1001 * with US English (en_US) translation. Other translations use
1002 * charsets that are set in translation settings.
1003 *
1004 * @global string $default_charset
1005 */
1006 $default_charset = 'iso-8859-1';
1007
1008 /**
1009 * Alternative Language Names Control
1010 *
1011 * This options allows displaying native language names in language
1012 * selection box.
1013 * @global bool $show_alternative_names
1014 * @since 1.5.0
1015 */
1016 $show_alternative_names = false;
1017
1018 /**
1019 * Aggressive Decoding Control
1020 *
1021 * This option enables reading of Eastern multibyte encodings.
1022 * Functions that provide this support are very cpu and memory intensive.
1023 * Don't enable this option unless you really need it.
1024 * @global bool $aggressive_decoding
1025 * @since 1.5.1
1026 */
1027 $aggressive_decoding = false;
1028
1029 /**
1030 * Lossy Encoding Control
1031 *
1032 * This option allows charset conversions when output charset does not support
1033 * all symbols used in original charset. Symbols unsupported by output charset
1034 * will be replaced with question marks.
1035 * @global bool $lossy_encoding
1036 * @since 1.5.1
1037 */
1038 $lossy_encoding = false;
1039
1040 /**
1041 * Controls use of time zone libraries
1042 *
1043 * Possible values:
1044 * <ul>
1045 * <li>0 - default, SquirrelMail uses GNU C timezone names in
1046 * TZ environment variables
1047 * <li>1 - strict, SquirrelMail uses 'TZ' subkey values in TZ
1048 * environment variables
1049 * <li>2 - custom, SquirrelMail loads time zone data from
1050 * config/timezones.php and uses time zone array keys in
1051 * TZ enviroment variables
1052 * <li>3 - custom strict, SquirrelMail loads time zone data from
1053 * config/timezones.php and uses TZ subkey values in
1054 * TZ enviroment variables
1055 * </ul>
1056 * Use of any other value switches to default SquirrelMail time zone
1057 * handling ($time_zone_type).
1058 * @global integer $time_zone_type
1059 * @since 1.5.1
1060 */
1061 $time_zone_type = 0;
1062
1063 /**
1064 * Location base
1065 *
1066 * This is used to build the URL to the SquirrelMail location.
1067 * It should contain only the protocol and hostname/port parts
1068 * of the URL; the full path will be appended automatically.
1069 *
1070 * If not specified or empty, it will be autodetected.
1071 *
1072 * Examples:
1073 * http://webmail.example.org
1074 * http://webmail.example.com:8080
1075 * https://webmail.example.com:6691
1076 *
1077 * To be clear: do not include any of the path elements, so if
1078 * SquirrelMail is at http://www.example.net/web/mail/src/login.php, you
1079 * write: http://www.example.net
1080 *
1081 * @global string $config_location_base
1082 * @since 1.5.2 and 1.4.8
1083 */
1084 $config_location_base = '';
1085
1086 /*** Tweaks ***/
1087 /**
1088 * Iframe sandbox code control
1089 *
1090 * Use iframe to render html emails
1091 * (temp option used during debuging of new code)
1092 * @global bool $use_iframe
1093 * @since 1.5.1
1094 */
1095 $use_iframe = false;
1096
1097 /**
1098 * PHP recode functions control
1099 *
1100 * Use experimental code with php recode functions when reading messages with
1101 * different encoding. This code is faster that original SM functions,
1102 * but it require php with recode support.
1103 *
1104 * Don't enable this option if you are not sure about availability of
1105 * recode support.
1106 * @global bool $use_php_recode
1107 * @since 1.5.0
1108 */
1109 $use_php_recode = false;
1110
1111 /**
1112 * PHP iconv functions control
1113 *
1114 * Use experimental code with php iconv functions when reading messages with
1115 * different encoding. This code is faster that original SM functions,
1116 * but it require php with iconv support and works only with some translations.
1117 *
1118 * Don't enable this option if you are not sure about availability of
1119 * iconv support.
1120 * @global bool $use_php_iconv
1121 * @since 1.5.0
1122 */
1123 $use_php_iconv = false;
1124
1125 /**
1126 * Controls remote configuration checks
1127 * @global boolean $allow_remote_configtest
1128 * @since 1.5.1
1129 */
1130 $allow_remote_configtest = false;
1131
1132 /**
1133 * Subscribe Listing Control
1134 *
1135 * this disables listing all of the folders on the IMAP Server to
1136 * generate the folder subscribe listbox (this can take a long time
1137 * when you have a lot of folders). Instead, a textbox will be
1138 * displayed allowing users to enter a specific folder name to subscribe to
1139 *
1140 * This option can't be changed by conf.pl
1141 * @global bool $no_list_for_subscribe
1142 */
1143 $no_list_for_subscribe = false;
1144
1145 /**
1146 * Color in config control
1147 *
1148 * This option is used only by conf.pl script to generate configuration
1149 * menu with some colors and is provided here only as reference.
1150 * @global integer $config_use_color
1151 */
1152 $config_use_color = 2;
1153
1154 /**
1155 * Ask User for Personal Information on login
1156 *
1157 * When a user logs in that doesn't have an email address configured,
1158 * redirect him/her to the options page with a request to fill in their
1159 * personal information.
1160 *
1161 * @global bool $ask_user_info
1162 */
1163 $ask_user_info = true;
1164