Remove unused hook
[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 2000-2013 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 * POP before SMTP server address
327 *
328 * When using POP3 before SMTP, if the POP server address is
329 * not the same as the SMTP server address, specify it here.
330 * If this is left empty, the SMTP server address will be
331 * used by default.
332 * @global bool $pop_before_smtp_host
333 */
334 $pop_before_smtp_host = '';
335
336
337 /*** Folder Settings ***/
338 /**
339 * Default IMAP folder prefix
340 *
341 * Many servers store mail in your home directory. With this, they
342 * store them in a subdirectory: mail/ or Mail/, etc. If your server
343 * does this, please set this to what the default mail folder should
344 * be. This is still a user preference, so they can change it if it
345 * is different for each user.
346 *
347 * Example:
348 * $default_folder_prefix = 'mail/';
349 * -- or --
350 * $default_folder_prefix = 'Mail/folders/';
351 *
352 * If you do not use this, set it to the empty string.
353 * @global string $default_folder_prefix
354 */
355 $default_folder_prefix = '';
356
357 /**
358 * User level prefix control
359 *
360 * If you do not wish to give them the option to change this, set it
361 * to false. Otherwise, if it is true, they can change the folder prefix
362 * to be anything.
363 * @global bool $show_prefix_option
364 */
365 $show_prefix_option = false;
366
367 /**
368 * The following are related to deleting messages.
369 * $default_move_to_trash
370 * If this is set to 'true', when 'delete' is pressed, it
371 * will attempt to move the selected messages to the folder
372 * named $trash_folder. If it's set to 'false', we won't even
373 * attempt to move the messages, just delete them.
374 * $default_move_to_sent
375 * If this is set to 'true', sent messages will be stored in
376 * $sent_folder by default.
377 * $default_save_as_draft
378 * If this is set to 'true', users are able to use $draft_folder
379 * to store their unfinished messages.
380 * $trash_folder
381 * This is the path to the default trash folder. For Cyrus
382 * IMAP, it would be 'INBOX.Trash', but for UW it would be
383 * 'Trash'. We need the full path name here.
384 * $draft_folder
385 * This is the patch to where Draft messages will be stored.
386 * $auto_expunge
387 * If this is true, when a message is moved or copied, the
388 * source mailbox will get expunged, removing all messages
389 * marked 'Deleted'.
390 * $sent_folder
391 * This is the path to where Sent messages will be stored.
392 * $delete_folder
393 * If this is true, when a folder is deleted then it will
394 * not get moved into the Trash folder.
395 * @global bool $default_move_to_trash
396 * @global bool $default_move_to_sent
397 * @global bool $default_save_as_draft
398 * @global string $trash_folder
399 * @global string $sent_folder
400 * @global string $draft_folder
401 * @global bool $auto_expunge
402 * @global bool $delete_folder
403 */
404 $default_move_to_trash = true;
405 $default_move_to_sent = true;
406 $default_save_as_draft = true;
407 $trash_folder = 'INBOX.Trash';
408 $sent_folder = 'INBOX.Sent';
409 $draft_folder = 'INBOX.Drafts';
410 $auto_expunge = true;
411 $delete_folder = false;
412
413 /**
414 * Special Folder Color Control
415 *
416 * Whether or not to use a special color for special folders. If not,
417 * special folders will be the same color as the other folders.
418 * @global bool $use_special_folder_color
419 */
420 $use_special_folder_color = true;
421
422 /**
423 * Create Special Folders Control
424 *
425 * Should I create the Sent and Trash folders automatically for
426 * a new user that doesn't already have them created?
427 * @global bool $auto_create_special
428 */
429 $auto_create_special = true;
430
431 /**
432 * List Special Folders First Control
433 *
434 * Whether or not to list the special folders first (true/false).
435 * @global bool $list_special_folders_first
436 */
437 $list_special_folders_first = true;
438
439 /**
440 * Subfolder Layout Control
441 *
442 * Are all your folders subfolders of INBOX (i.e. cyrus IMAP server).
443 * If you are unsure, set it to false.
444 * @global bool $default_sub_of_inbox
445 */
446 $default_sub_of_inbox = true;
447
448 /**
449 * Subfolder Format Control
450 *
451 * Some IMAP daemons (UW) handle folders weird. They only allow a
452 * folder to contain either messages or other folders, not both at
453 * the same time. This option controls whether or not to display an
454 * option during folder creation. The option toggles which type of
455 * folder it should be.
456 *
457 * If this option confuses you, just set it to 'true'. You can not hurt
458 * anything if it's true, but some servers will respond weird if it's
459 * false. (Cyrus works fine whether it's true OR false).
460 * @global bool $show_contain_subfolders_option
461 */
462 $show_contain_subfolders_option = false;
463
464 /**
465 * These next two options set the defaults for the way that the
466 * users see their folder list.
467 * $default_unseen_notify
468 * Specifies whether or not the users will see the number of
469 * unseen in each folder by default and also which folders to
470 * do this to. Valid values are: 1=none, 2=inbox, 3=all.
471 * $default_unseen_type
472 * Specifies the type of notification to give the users by
473 * default. Valid choice are: 1=(4), 2=(4,25).
474 * @global integer $default_unseen_notify
475 * @global integer $default_unseen_type
476 */
477 $default_unseen_notify = 2;
478 $default_unseen_type = 1;
479
480 /**
481 * NoSelect Fix Control
482 *
483 * This enables the no select fix for Cyrus when subfolders
484 * exist but parent folders do not
485 * @global bool $noselect_fix_enable
486 */
487 $noselect_fix_enable = false;
488
489 /*** General options ***/
490 /**
491 * Path to the data/ directory
492 *
493 * You need to create this directory yourself (see INSTALL).
494 *
495 * It is a possible security hole to have a writable directory
496 * under the web server's root directory (ex: /home/httpd/html).
497 * The path name can be absolute or relative (to the config directory).
498 * If path is relative, it must use SM_PATH constant.
499 * Here are two examples:
500 *
501 * Absolute:
502 * $data_dir = '/var/local/squirrelmail/data/';
503 *
504 * Relative (to main SM directory):
505 * $data_dir = SM_PATH . 'data/';
506 * (NOT recommended: you need to secure apache to make sure these
507 * files are not world readable)
508 *
509 * @global string $data_dir
510 */
511 $data_dir = '/var/local/squirrelmail/data/';
512
513 /**
514 * Attachments directory
515 *
516 * Path to directory used for storing attachments while a mail is
517 * being sent. There are a few security considerations regarding
518 * this directory:
519 * + It should have the permission 733 (rwx-wx-wx) to make it
520 * impossible for a random person with access to the webserver to
521 * list files in this directory. Confidential data might be laying
522 * around there.
523 * + Since the webserver is not able to list the files in the content
524 * is also impossible for the webserver to delete files lying around
525 * there for too long. You should have some script that deletes
526 * left over temp files.
527 * + It should probably be another directory than data_dir.
528 * @global string $attachment_dir
529 */
530 $attachment_dir = '/var/local/squirrelmail/attach/';
531
532 /**
533 * Hash level used for data directory.
534 *
535 * This option allows spliting file based SquirrelMail user
536 * data storage directory into several subfolders. Number from
537 * 0 to 4 allows allows having up to four subfolder levels.
538 *
539 * Hashing should speed up directory access if you have big number
540 * of users (500 and more).
541 * @global integer $dir_hash_level
542 */
543 $dir_hash_level = 0;
544
545 /**
546 * Default Size of Folder List
547 *
548 * This is the default size of the folder list. Default
549 * is 150, but you can set it to whatever you wish.
550 * @global string $default_left_size
551 */
552 $default_left_size = '150';
553
554 /**
555 * Username Case Control
556 *
557 * Some IMAP servers allow a username (like 'bob') to log in if they use
558 * uppercase in their name (like 'Bob' or 'BOB'). This creates extra
559 * preference files. Toggling this option to true will transparently
560 * change all usernames to lowercase.
561 * @global bool $force_username_lowercase
562 */
563 $force_username_lowercase = false;
564
565 /**
566 * Email Priority Control
567 *
568 * This option enables use of email priority flags by end users.
569 * @global bool $default_use_priority
570 */
571 $default_use_priority = true;
572
573 /**
574 * SquirrelMail Attributions Control
575 *
576 * This option disables display of "created by SquirrelMail developers"
577 * strings and links.
578 * @global bool $hide_sm_attributions
579 * @since 1.2.0
580 */
581 $hide_sm_attributions = false;
582
583 /**
584 * Delivery Receipts Control
585 *
586 * This option enables use of read/delivery receipts by end users.
587 * @global bool $default_use_mdn
588 */
589 $default_use_mdn = true;
590
591 /**
592 * Identity Controls
593 *
594 * If you don't want to allow users to change their email address
595 * then you can set $edit_identity to false, if you want them to
596 * not be able to change their full name too then set $edit_name
597 * to false as well. $edit_name has no effect unless $edit_identity
598 * is false;
599 * @global bool $edit_identity
600 * @global bool $edit_name
601 */
602 $edit_identity = true;
603 $edit_name = true;
604
605 /**
606 * SquirrelMail adds username information to every sent email.
607 * It is done in order to prevent possible sender forging when
608 * end users are allowed to change their email and name
609 * information.
610 *
611 * You can disable this header, if you think that it violates
612 * user's privacy or security. Please note, that setting will
613 * work only when users are not allowed to change their identity.
614 *
615 * See SquirrelMail bug tracker #847107 for more details about it.
616 * @global bool $hide_auth_header
617 * @since 1.5.1 and 1.4.5
618 */
619 $hide_auth_header = false;
620
621 /**
622 * Server Side Threading Control
623 *
624 * Set it to true, if you want to disable server side thread
625 * sorting options. Your IMAP server must support the THREAD
626 * extension for this to have any effect.
627 *
628 * Older SquirrelMail versions used $allow_thread_sort option.
629 * @global bool $disable_thread_sort
630 * @since 1.5.1
631 */
632 $disable_thread_sort = false;
633
634 /**
635 * Server Side Sorting Control
636 *
637 * Set it to true, if you want to disable server side sorting
638 * and use SM client side sorting instead (client side sorting
639 * can be slow). Your IMAP server must support the SORT extension
640 * for this to have any effect.
641 *
642 * Older SquirrelMail versions used $allow_server_sort option.
643 * @global bool $disable_server_sort
644 * @since 1.5.1
645 */
646 $disable_server_sort = false;
647
648 /**
649 * IMAP Charset Use Control
650 *
651 * This option allows you to choose if SM uses charset search
652 * Your imap server should support SEARCH CHARSET command for
653 * this to work.
654 * @global bool $allow_charset_search
655 */
656 $allow_charset_search = true;
657
658 /**
659 * Search functions control
660 *
661 * This option allows you to control the use of advanced search form.
662 * Set to 0 to enable basic search only, 1 to enable advanced search only
663 * or 2 to enable both.
664 * @global integer $allow_advanced_search
665 */
666 $allow_advanced_search = 0;
667
668 /**
669 * PHP session name.
670 *
671 * Leave this alone unless you know what you are doing.
672 * @global string $session_name
673 */
674 $session_name = 'SQMSESSID';
675
676 /**
677 * Secure Cookies
678 *
679 * Only transmit cookies via a secure connection
680 * if the session was started using HTTPS/SSL?
681 *
682 * Highly recommended
683 *
684 * @global bool $only_secure_cookies
685 * @since 1.5.2 and 1.4.16
686 */
687 $only_secure_cookies = true;
688
689 /**
690 * Secure Forms
691 *
692 * Disable security tokens used to authenticate the
693 * source of user data received by SquirrelMail?
694 *
695 * It is highly discouraged to enable this setting.
696 *
697 * @global bool $disable_security_tokens
698 * @since 1.5.2 and 1.4.20RC1
699 */
700 $disable_security_tokens = false;
701
702 /**
703 * Check Page Referrer
704 *
705 * Enforces a safety check on page requests by checking
706 * that the referrer is the domain specified by this
707 * setting. If this setting is "###DOMAIN###", the
708 * current value of the $domain variable will be used
709 * for the check.
710 *
711 * If a browser doesn't send referrer data, this check
712 * will be silently bypassed.
713 *
714 * Examples:
715 * $check_referrer = 'example.com';
716 * $check_referrer = '###DOMAIN###';
717 *
718 * @global string $check_referrer
719 * @since 1.5.2 and 1.4.20RC1
720 */
721 $check_referrer = '';
722
723 /**
724 * Security Image Type
725 *
726 * Switches between using a transparent image
727 * and one that states "this image has been
728 * removed for security reasons"
729 *
730 * @global bool $use_transparent_security_image
731 * @since 1.5.2 and 1.4.23
732 */
733 $use_transparent_security_image = true;
734
735
736 /**
737 * User Themes
738 * You can define your own theme and put it in directory in SM_PATH/css/.
739 * You must call it as the example below. You can name the theme
740 * whatever you want.
741 *
742 * To add a new theme to the options that users can choose from, just
743 * add a new number to the array at the bottom, and follow the pattern.
744 *
745 * $user_theme_default sets theme that will be used by default
746 *
747 * @global integer $user_theme_default
748 * @since 1.5.2
749 */
750 $user_theme_default = 0;
751
752 /**
753 * Listing of installed themes
754 * @global array $user_themes
755 * @since 1.5.2
756 */
757 $user_themes[0]['PATH'] = 'none';
758 $user_themes[0]['NAME'] = 'Default';
759
760 $user_themes[1]['PATH'] = '../css/blue_gradient/';
761 $user_themes[1]['NAME'] = 'Blue Options';
762
763 /**
764 * Message Icons control
765 *
766 * Use icons for message and folder markers
767 * @global bool $use_icons
768 * @since 1.5.1
769 */
770 $use_icons = true;
771
772 /**
773 * Icon Themes
774 * You can create your own icon themes and put them in a directory in
775 * SM_PATH/images/themes/. Your users will be able to choose whatever
776 * icon themes are listed below.
777 *
778 * To add a new theme to the list of available icon themes, just add a new
779 * number to the array below and follow the pattern
780 *
781 * $icon_theme_default sets the theme that will be used by default.
782 * $icon_theme_fallback specifies which theme will be used if an icon is
783 * not found in the selected theme
784 *
785 * @global integer $icon_theme_def
786 * @global integer $icon_theme_fallback
787 * @since 1.5.2
788 */
789 $icon_theme_def = 1;
790 $icon_theme_fallback = 3;
791
792 /**
793 * Listing of installed icon themes
794 * @global array $icon_themes
795 * @since 1.5.2
796 */
797 $icon_themes[0]['PATH'] = 'none';
798 $icon_themes[0]['NAME'] = 'No Icons';
799
800 $icon_themes[1]['PATH'] = 'template';
801 $icon_themes[1]['NAME'] = 'Template Default Icons';
802
803 $icon_themes[2]['PATH'] = '../images/themes/default/';
804 $icon_themes[2]['NAME'] = 'Default Icon Set';
805
806 $icon_themes[3]['PATH'] = '../images/themes/xp/';
807 $icon_themes[3]['NAME'] = 'XP Style Icons';
808
809 /**
810 * Templates
811 * You can define your own template set (skin) and put it in a new
812 * directory under SM_PATH/templates. The ID must match the name of
813 * the template directory as the example below. You can name the
814 * template whatever you want. For an example of a template, see
815 * the ones included in the SM_PATH/templates directory.
816 *
817 * To add a new template to the options that users can choose from, just
818 * add a new number to the array at the bottom, and follow the pattern.
819 *
820 * $templateset_default sets the skin that will be used by default
821 * when a user doesn't have a skin selection
822 * in their preferences. (Must be the "ID" of
823 * the desired template set)
824 *
825 * $templateset_fallback tells SquirrelMail which template set (skin)
826 * to use when looking for a file that is not
827 * contained within whatever skin is currently
828 * being used. (Must be the "ID" of the desired
829 * template set)
830 *
831 * $rpc_templateset sets the skin that will be used by default
832 * when a user is making an RPC request. This
833 * does not usually need to be changed, but
834 * can be used to change the RPC protocol that
835 * is used to respond to RPC requets. (Must be
836 * the "ID" of the desired template set and
837 * should NOT be a template set that is included
838 * in the $aTemplateSet list; PLEASE NOTE that
839 * new RPC template sets should always be named
840 * "<skin name>_rpc", as SquirrelMail will assume
841 * any template sets ending in "_rpc" are intended
842 * for its RPC interface only)
843 *
844 * @global string $templateset_default
845 * @global string $templateset_fallback
846 * @global string $rpc_templateset
847 */
848 $templateset_default = 'default';
849 $templateset_fallback = 'default';
850 $rpc_templateset = 'default_rpc';
851
852 $aTemplateSet[0]['ID'] = 'default';
853 $aTemplateSet[0]['NAME'] = 'Default';
854 $aTemplateSet[1]['ID'] = 'default_advanced';
855 $aTemplateSet[1]['NAME'] = 'Advanced';
856
857 /**
858 * Default interface font size.
859 * @global string $default_fontsize
860 * @since 1.5.1
861 */
862 $default_fontsize = '';
863
864 /**
865 * Default font set
866 * @global string $default_fontset
867 * @since 1.5.1
868 */
869 $default_fontset = '';
870
871 /**
872 * List of available fontsets.
873 * @global array $fontsets
874 * @since 1.5.1
875 */
876 $fontsets = array();
877 $fontsets['serif'] = 'serif';
878 $fontsets['sans'] = 'helvetica,arial,sans-serif';
879 $fontsets['comicsans'] = 'comic sans ms,sans-serif';
880 $fontsets['verasans'] = 'bitstream vera sans,verdana,sans-serif';
881 $fontsets['tahoma'] = 'tahoma,sans-serif';
882
883 /**
884 * LDAP server(s)
885 * Array of arrays with LDAP server parameters. See
886 * functions/abook_ldap_server.php for a list of possible
887 * parameters
888 *
889 * EXAMPLE:
890 * $ldap_server[0] = Array(
891 * 'host' => 'memberdir.netscape.com',
892 * 'name' => 'Netcenter Member Directory',
893 * 'base' => 'ou=member_directory,o=netcenter.com'
894 * );
895 *
896 * NOTE: please see security note at the top of this file when
897 * entering a password.
898 */
899 // Add your ldap server options here
900
901 /**
902 * Javascript in Addressbook Control
903 *
904 * Users may search their addressbook via either a plain HTML or Javascript
905 * enhanced user interface. This option allows you to set the default choice.
906 * Set this default choice as either:
907 * true = javascript
908 * false = html
909 * @global bool $default_use_javascript_addr_book
910 */
911 $default_use_javascript_addr_book = false;
912
913 /**
914 * Shared filebased address book
915 * @global string $abook_global_file
916 * @since 1.5.1 and 1.4.4
917 */
918 $abook_global_file = '';
919
920 /**
921 * Writing into shared address book control
922 * @global bool $abook_global_file_writeable
923 * @since 1.5.1 and 1.4.4
924 */
925 $abook_global_file_writeable = false;
926
927 /**
928 * Listing of shared address book control
929 * @global bool $abook_global_file_listing
930 * @since 1.5.1
931 */
932 $abook_global_file_listing = true;
933
934 /**
935 * Controls file based address book entry size
936 *
937 * This setting controls space allocated to file based address book records.
938 * End users will be unable to save address book entry, if total entry size
939 * (quoted address book fields + 4 delimiters + linefeed) exceeds allowed
940 * address book length size.
941 *
942 * Same setting is applied to personal and global file based address books.
943 *
944 * It is strongly recommended to keep default setting value. Change it only
945 * if you really want to store address book entries that are bigger than two
946 * kilobytes (2048).
947 * @global integer $abook_file_line_length
948 * @since 1.5.2
949 */
950 $abook_file_line_length = 2048;
951
952 /**
953 * MOTD
954 *
955 * This is a message that is displayed immediately after a user logs in.
956 * @global string $motd
957 */
958 $motd = "";
959
960
961 /**
962 * To install plugins, just add elements to this array that have
963 * the plugin directory name relative to the /plugins/ directory.
964 * For instance, for the 'squirrelspell' plugin, you'd put a line like
965 * the following.
966 * $plugins[] = 'squirrelspell';
967 * $plugins[] = 'listcommands';
968 */
969 // Add list of enabled plugins here
970
971
972 /**
973 * To disable all plugins regardless of any that are installed
974 * above, turn on $disable_plugins. To disable them ONLY for
975 * one user, put that username into $disable_plugins_user.
976 * @global boolean $disable_plugins
977 * @global string $disable_plugins_user
978 * @since 1.5.2
979 */
980 $disable_plugins = false;
981 $disable_plugins_user = '';
982
983
984 /*** Database ***/
985 /**
986 * Read the administrator's manual in order to get more information
987 * about these settings.
988 */
989 /**
990 * Database-driven private addressbooks
991 * DSN (Data Source Name) for a database where the private
992 * addressbooks are stored. See the administrator's manual for more info.
993 * If it is not set, the addressbooks are stored in files
994 * in the data dir.
995 * The DSN is in the format: mysql://user:pass@hostname/dbname
996 * The table is the name of the table to use within the
997 * specified database.
998 *
999 * NOTE: please see security note at the top of this file when
1000 * entering a password.
1001 */
1002 $addrbook_dsn = '';
1003 $addrbook_table = 'address';
1004 /**
1005 * Database used to store user data
1006 */
1007 $prefs_dsn = '';
1008 $prefs_table = 'userprefs';
1009 /**
1010 * Preference key field
1011 * @global string $prefs_key_field
1012 */
1013 $prefs_key_field = 'prefkey';
1014 /**
1015 * Size of preference key field
1016 * @global integer $prefs_key_size
1017 * @since 1.5.1
1018 */
1019 $prefs_key_size = 64;
1020 /**
1021 * Preference owner field
1022 * @global string $prefs_user_field
1023 */
1024 $prefs_user_field = 'user';
1025 /**
1026 * Size of preference owner field
1027 * @global integer $prefs_user_size
1028 * @since 1.5.1
1029 */
1030 $prefs_user_size = 128;
1031 /**
1032 * Preference value field
1033 * @global string $prefs_val_field
1034 */
1035 $prefs_val_field = 'prefval';
1036 /**
1037 * Size of preference key field
1038 * @global integer $prefs_val_size
1039 * @since 1.5.1
1040 */
1041 $prefs_val_size = 65536;
1042
1043 /*** Global sql database options ***/
1044 /**
1045 * DSN of global address book database
1046 * @global string $addrbook_global_dsn
1047 * @since 1.5.1 and 1.4.4
1048 */
1049 $addrbook_global_dsn = '';
1050 /**
1051 * Table used for global database address book
1052 * @global string $addrbook_global_table
1053 * @since 1.5.1 and 1.4.4
1054 */
1055 $addrbook_global_table = 'global_abook';
1056 /**
1057 * Control writing into global database address book
1058 * @global boolean $addrbook_global_writeable
1059 * @since 1.5.1 and 1.4.4
1060 */
1061 $addrbook_global_writeable = false;
1062 /**
1063 * Control listing of global database address book
1064 * @global boolean $addrbook_global_listing
1065 * @since 1.5.1 and 1.4.4
1066 */
1067 $addrbook_global_listing = false;
1068
1069 /*** Language settings ***/
1070 /**
1071 * Default language
1072 *
1073 * This is the default language. It is used as a last resort
1074 * if SquirrelMail can't figure out which language to display.
1075 * Language names usually consist of language code, undercore
1076 * symbol and country code
1077 * @global string $squirrelmail_default_language
1078 */
1079 $squirrelmail_default_language = 'en_US';
1080
1081 /**
1082 * Default Charset
1083 *
1084 * This option controls what character set is used when sending
1085 * mail and when sending HTML to the browser. Option works only
1086 * with US English (en_US) translation. Other translations use
1087 * charsets that are set in translation settings.
1088 *
1089 * @global string $default_charset
1090 */
1091 $default_charset = 'iso-8859-1';
1092
1093 /**
1094 * Alternative Language Names Control
1095 *
1096 * This options allows displaying native language names in language
1097 * selection box.
1098 * @global bool $show_alternative_names
1099 * @since 1.5.0
1100 */
1101 $show_alternative_names = false;
1102
1103 /**
1104 * Aggressive Decoding Control
1105 *
1106 * This option enables reading of Eastern multibyte encodings.
1107 * Functions that provide this support are very cpu and memory intensive.
1108 * Don't enable this option unless you really need it.
1109 * @global bool $aggressive_decoding
1110 * @since 1.5.1
1111 */
1112 $aggressive_decoding = false;
1113
1114 /**
1115 * Lossy Encoding Control
1116 *
1117 * This option allows charset conversions when output charset does not support
1118 * all symbols used in original charset. Symbols unsupported by output charset
1119 * will be replaced with question marks.
1120 * @global bool $lossy_encoding
1121 * @since 1.5.1
1122 */
1123 $lossy_encoding = false;
1124
1125 /**
1126 * Controls use of time zone libraries
1127 *
1128 * Possible values:
1129 * <ul>
1130 * <li>0 - default, SquirrelMail uses GNU C timezone names in
1131 * TZ environment variables
1132 * <li>1 - strict, SquirrelMail uses 'TZ' subkey values in TZ
1133 * environment variables
1134 * <li>2 - custom, SquirrelMail loads time zone data from
1135 * config/timezones.php and uses time zone array keys in
1136 * TZ enviroment variables
1137 * <li>3 - custom strict, SquirrelMail loads time zone data from
1138 * config/timezones.php and uses TZ subkey values in
1139 * TZ enviroment variables
1140 * </ul>
1141 * Use of any other value switches to default SquirrelMail time zone
1142 * handling ($time_zone_type).
1143 * @global integer $time_zone_type
1144 * @since 1.5.1
1145 */
1146 $time_zone_type = 0;
1147
1148 /**
1149 * Location base
1150 *
1151 * This is used to build the URL to the SquirrelMail location.
1152 * It should contain only the protocol and hostname/port parts
1153 * of the URL; the full path will be appended automatically.
1154 *
1155 * If not specified or empty, it will be autodetected.
1156 *
1157 * Examples:
1158 * http://webmail.example.org
1159 * http://webmail.example.com:8080
1160 * https://webmail.example.com:6691
1161 *
1162 * To be clear: do not include any of the path elements, so if
1163 * SquirrelMail is at http://www.example.net/web/mail/src/login.php, you
1164 * write: http://www.example.net
1165 *
1166 * @global string $config_location_base
1167 * @since 1.5.2 and 1.4.8
1168 */
1169 $config_location_base = '';
1170
1171 /*** Tweaks ***/
1172 /**
1173 * Iframe sandbox code control
1174 *
1175 * Use iframe to render html emails
1176 * (temp option used during debuging of new code)
1177 * @global bool $use_iframe
1178 * @since 1.5.1
1179 */
1180 $use_iframe = false;
1181
1182 /**
1183 * PHP recode functions control
1184 *
1185 * Use experimental code with php recode functions when reading messages with
1186 * different encoding. This code is faster that original SM functions,
1187 * but it require php with recode support.
1188 *
1189 * Don't enable this option if you are not sure about availability of
1190 * recode support.
1191 * @global bool $use_php_recode
1192 * @since 1.5.0
1193 */
1194 $use_php_recode = false;
1195
1196 /**
1197 * PHP iconv functions control
1198 *
1199 * Use experimental code with php iconv functions when reading messages with
1200 * different encoding. This code is faster that original SM functions,
1201 * but it require php with iconv support and works only with some translations.
1202 *
1203 * Don't enable this option if you are not sure about availability of
1204 * iconv support.
1205 * @global bool $use_php_iconv
1206 * @since 1.5.0
1207 */
1208 $use_php_iconv = false;
1209
1210 /**
1211 * Output Buffering
1212 *
1213 * In some cases, buffering all output allows more complex functionality,
1214 * especially for plugins that want to add headers on hooks that are beyond
1215 * the point of output having been sent to the browser otherwise (although
1216 * most plugins that need this feature will turn it on automatically by
1217 * themselves).
1218 *
1219 * It is also possible to define a custom output handler as needed by special
1220 * environments. If $buffered_output_handler is non-empty, a function named
1221 * the same as the value of $buffered_output_handler should be defined in
1222 * config_local.php.
1223 *
1224 */
1225 $buffer_output = false;
1226 $buffered_output_handler = '';
1227
1228 /**
1229 * Allow Remote configtest Access
1230 *
1231 * Controls remote configuration checks
1232 * @global boolean $allow_remote_configtest
1233 * @since 1.5.1
1234 */
1235 $allow_remote_configtest = false;
1236
1237 /**
1238 * SquirrelMail Debug Mode
1239 *
1240 * Various debugging levels can be enabled using this setting.
1241 * More than one mode can be used at once by combining them
1242 * with pipes ("|"). See the SM_DEBUG_MODE_* constants in
1243 * include/constants.php
1244 */
1245 $sm_debug_mode = SM_DEBUG_MODE_OFF;
1246
1247 /**
1248 * "Secured Configuration" Mode
1249 *
1250 * Enable/disable "Secured Configuration" mode, wherein certain
1251 * security-sensitive configuration settings are made immutable
1252 * by other code.
1253 */
1254 $secured_config = true;
1255
1256 /**
1257 * HTTPS Port
1258 *
1259 * This is the HTTPS (SSL-secured HTTP) port. It can be left empty,
1260 * in which case SquirrelMail will assume the standard port 443.
1261 * Make sure to set this correctly when serving HTTPS on a non-
1262 * standard port.
1263 */
1264 $sq_https_port = 443;
1265
1266 /**
1267 * Ignore HTTP_X_FORWARDED_* headers?
1268 *
1269 * Whether or not HTTP_X_FORWARDED_* headers are respected by
1270 * SquirrelMail (or plugins).
1271 */
1272 $sq_ignore_http_x_forwarded_headers = true;
1273
1274 /**
1275 * Subscribe Listing Control
1276 *
1277 * this disables listing all of the folders on the IMAP Server to
1278 * generate the folder subscribe listbox (this can take a long time
1279 * when you have a lot of folders). Instead, a textbox will be
1280 * displayed allowing users to enter a specific folder name to subscribe to
1281 *
1282 * This option can't be changed by conf.pl
1283 * @global bool $no_list_for_subscribe
1284 */
1285 $no_list_for_subscribe = false;
1286
1287 /**
1288 * Color in config control
1289 *
1290 * This option is used only by conf.pl script to generate configuration
1291 * menu with some colors and is provided here only as reference.
1292 * @global integer $config_use_color
1293 */
1294 $config_use_color = 2;
1295
1296 /**
1297 * Ask User for Personal Information on login
1298 *
1299 * When a user logs in that doesn't have an email address configured,
1300 * redirect him/her to the options page with a request to fill in their
1301 * personal information.
1302 *
1303 * @global bool $ask_user_info
1304 */
1305 $ask_user_info = true;
1306