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