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