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