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