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