Source for file config_default.php

Documentation is available at config_default.php

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

Documentation generated on Mon, 13 Jan 2020 04:24:23 +0100 by phpDocumentor 1.4.3