Default SquirrelMail configuration file
BEFORE EDITING THIS FILE!
Don't edit this file directly. Copy it to config.php before you edit it. However, it is best to use the configuration script conf.pl if at all possible. That is the easiest and cleanest way to configure.
Note on SECURITY: some options require putting a password in this file. Please make sure that you adapt its permissions appropriately to avoid passwords being leaked to e.g. other system users. Take extra care when the webserver is shared with untrusted users.
Controls file based address book entry size
This setting controls space allocated to file based address book records. End users will be unable to save address book entry, if total entry size (quoted address book fields + 4 delimiters + linefeed) exceeds allowed address book length size.
Same setting is applied to personal and global file based address books.
It is strongly recommended to keep default setting value. Change it only if you really want to store address book entries that are bigger than two kilobytes (2048).
Shared filebased address book
Listing of shared address book control
Writing into shared address book control
DSN of global address book database
Control listing of global database address book
Table used for global database address book
Control writing into global database address book
Aggressive Decoding Control
This option enables reading of Eastern multibyte encodings. Functions that provide this support are very cpu and memory intensive. Don't enable this option unless you really need it.
Search functions control
This option allows you to control the use of advanced search form. Set to 0 to enable basic search only, 1 to enable advanced search only or 2 to enable both.
IMAP Charset Use Control
This option allows you to choose if SM uses charset search Your imap server should support SEARCH CHARSET command for this to work.
Allow Remote configtest Access
Controls remote configuration checks
Ask User for Personal Information on login
When a user logs in that doesn't have an email address configured, redirect him/her to the options page with a request to fill in their personal information.
Attachments directory
Path to directory used for storing attachments while a mail is being sent. There are a few security considerations regarding this directory:
Create Special Folders Control
Should I create the Sent and Trash folders automatically for a new user that doesn't already have them created?
Check Page Referrer
Enforces a safety check on page requests by checking that the referrer is the domain specified by this setting. If this setting is "###DOMAIN###", the current value of the $domain variable will be used for the check.
If a browser doesn't send referrer data, this check will be silently bypassed.
Examples: $check_referrer = 'example.com'; $check_referrer = '###DOMAIN###';
Location base
This is used to build the URL to the SquirrelMail location. It should contain only the protocol and hostname/port parts of the URL; the full path will be appended automatically.
If not specified or empty, it will be autodetected.
Examples: http://webmail.example.org http://webmail.example.com:8080 https://webmail.example.com:6691
To be clear: do not include any of the path elements, so if SquirrelMail is at http://www.example.net/web/mail/src/login.php, you write: http://www.example.net
Color in config control
This option is used only by conf.pl script to generate configuration menu with some colors and is provided here only as reference.
Path to the data/ directory
You need to create this directory yourself (see INSTALL).
It is a possible security hole to have a writable directory under the web server's root directory (ex: /home/httpd/html). The path name can be absolute or relative (to the config directory). If path is relative, it must use SM_PATH constant. Here are two examples:
Absolute: $data_dir = '/var/local/squirrelmail/data/';
Relative (to main SM directory): $data_dir = SM_PATH . 'data/'; (NOT recommended: you need to secure apache to make sure these files are not world readable)
Default Charset
This option controls what character set is used when sending mail and when sending HTML to the browser. Option works only with US English (en_US) translation. Other translations use charsets that are set in translation settings.
Default IMAP folder prefix
Many servers store mail in your home directory. With this, they store them in a subdirectory: mail/ or Mail/, etc. If your server does this, please set this to what the default mail folder should be. This is still a user preference, so they can change it if it is different for each user.
Example: $default_folder_prefix = 'mail/'; -- or -- $default_folder_prefix = 'Mail/folders/';
If you do not use this, set it to the empty string.
Default font set
Default interface font size.
Default Size of Folder List
This is the default size of the folder list. Default is 150, but you can set it to whatever you wish.
Subfolder Layout Control
Are all your folders subfolders of INBOX (i.e. cyrus IMAP server). If you are unsure, set it to false.
These next two options set the defaults for the way that the users see their folder list.
$default_unseen_notify Specifies whether or not the users will see the number of unseen in each folder by default and also which folders to do this to. Valid values are: 1=none, 2=inbox, 3=all. $default_unseen_type Specifies the type of notification to give the users by default. Valid choice are: 1=(4), 2=(4,25).
Javascript in Addressbook Control
Users may search their addressbook via either a plain HTML or Javascript enhanced user interface. This option allows you to set the default choice. Set this default choice as either: true = javascript false = html
Delivery Receipts Control
This option enables use of read/delivery receipts by end users.
Email Priority Control
This option enables use of email priority flags by end users.
The following are related to deleting messages.
$default_move_to_trash If this is set to 'true', when 'delete' is pressed, it will attempt to move the selected messages to the folder named $trash_folder. If it's set to 'false', we won't even attempt to move the messages, just delete them. $default_move_to_sent If this is set to 'true', sent messages will be stored in $sent_folder by default. $default_save_as_draft If this is set to 'true', users are able to use $draft_folder to store their unfinished messages. $trash_folder This is the path to the default trash folder. For Cyrus IMAP, it would be 'INBOX.Trash', but for UW it would be 'Trash'. We need the full path name here. $draft_folder This is the patch to where Draft messages will be stored. $auto_expunge If this is true, when a message is moved or copied, the source mailbox will get expunged, removing all messages marked 'Deleted'. $sent_folder This is the path to where Sent messages will be stored. $delete_folder If this is true, when a folder is deleted then it will not get moved into the Trash folder.
Hash level used for data directory.
This option allows spliting file based SquirrelMail user data storage directory into several subfolders. Number from
To disable all plugins regardless of any that are installed above, turn on $disable_plugins. To disable them ONLY for one user, put that username into $disable_plugins_user.
Secure Forms
Disable security tokens used to authenticate the source of user data received by SquirrelMail?
It is highly discouraged to enable this setting.
Server Side Sorting Control
Set it to true, if you want to disable server side sorting and use SM client side sorting instead (client side sorting can be slow). Your IMAP server must support the SORT extension for this to have any effect.
Older SquirrelMail versions used $allow_server_sort option.
Server Side Threading Control
Set it to true, if you want to disable server side thread sorting options. Your IMAP server must support the THREAD extension for this to have any effect.
Older SquirrelMail versions used $allow_thread_sort option.
Show login error from the IMAP server (true) or show the traditional/generic "Unknown user or password incorrect" (false)?
Default Domain
The domain part of local email addresses. This is for all messages sent out from this server. Reply address is generated by $username@$domain Example: In [email protected], example.com is the domain.
Identity Controls
If you don't want to allow users to change their email address then you can set $edit_identity to false; if you want them to not be able to change their full name too then set $edit_name to false as well. $edit_reply_to likewise controls users' ability to change their reply-to address. $edit_name and $edit_reply_to have no effect unless $edit_identity is false;
SquirrelMail header encryption
Encryption key allows to hide SquirrelMail Received: headers in outbound messages. Interface uses encryption key to encode username, remote address and proxied address, then stores encoded information in X-Squirrel-* headers.
Warning: used encryption function is not bulletproof. When used with static encryption keys, it provides only minimal security measures and information can be decoded quickly.
Encoded information can be decoded with decrypt_headers.php script from SquirrelMail contrib/ directory.
List of available fontsets.
Username Case Control
Some IMAP servers allow a username (like 'bob') to log in if they use uppercase in their name (like 'Bob' or 'BOB'). This creates extra preference files. Toggling this option to true will transparently change all usernames to lowercase.
Top frame
By default SquirrelMail takes up the whole browser window, this allows you to embed it within sites using frames. Set this to the frame you want it to stay in.
SquirrelMail adds username information to every sent email.
It is done in order to prevent possible sender forging when end users are allowed to change their email and name information.
You can disable this header, if you think that it violates user's privacy or security. Please note, that setting will work only when users are not allowed to change their identity.
See SquirrelMail bug tracker #847107 for more details about it.
SquirrelMail Attributions Control
This option disables display of "created by SquirrelMail developers" strings and links.
Listing of installed icon themes
Icon Themes You can create your own icon themes and put them in a directory in SM_PATH/images/themes/. Your users will be able to choose whatever icon themes are listed below.
To add a new theme to the list of available icon themes, just add a new number to the array below and follow the pattern
$icon_theme_default sets the theme that will be used by default. $icon_theme_fallback specifies which theme will be used if an icon is not found in the selected theme
IMAP server address
The dns name (or IP address) for your imap server.
IMAP authentication mechanism
auth_mech can be either 'login','plain', 'cram-md5', or 'digest-md5'
IMAP server type
The type of IMAP server you are running. Valid type are the following (case is important): bincimap courier cyrus dovecot exchange hmailserver macosx mercury32 uw other
Please note that this changes only some of server settings.
In order to set everything correctly, you need to adjust several SquirrelMail options. These options are listed in doc/presets.txt
Time offset inversion
If you are running on a machine that doesn't have the tm_gmtoff value in your time structure and if you are in a time zone that has a negative offset, you need to set this value to 1. This is typically people in the US that are running Solaris 7.
List Special Folders First Control
Whether or not to list the special folders first (true/false).
Lossy Encoding Control
This option allows charset conversions when output charset does not support all symbols used in original charset. Symbols unsupported by output charset will be replaced with question marks.
NoSelect Fix Control
This enables the no select fix for Cyrus when subfolders exist but parent folders do not
Subscribe Listing Control
this disables listing all of the folders on the IMAP Server to generate the folder subscribe listbox (this can take a long time when you have a lot of folders). Instead, a textbox will be displayed allowing users to enter a specific folder name to subscribe to
This option can't be changed by conf.pl
Secure Cookies
Only transmit cookies via a secure connection if the session was started using HTTPS/SSL?
Highly recommended
IMAP folder delimiter
This is the delimiter that your IMAP server uses to distinguish between folders. For example, Cyrus uses '.' as the delimiter and a complete folder would look like 'INBOX.Friends.Bob', while UW uses '/' and would look like 'INBOX/Friends/Bob'. Normally this should be left at 'detect' but if you are sure you know what delimiter your server uses, you can specify it here.
To have it autodetect the delimiter, set it to 'detect'.
Organization's logo picture (blank if none)
The height of the logo (0 for default)
The width of the logo (0 for default)
Organization's name
Webmail Title
This is the web page title that appears at the top of the browser window.
POP before SMTP setting
Do you wish to use POP3 before SMTP? Your server must support this in order for SquirrelMail to work with it.
POP before SMTP server address
When using POP3 before SMTP, if the POP server address is not the same as the SMTP server address, specify it here. If this is left empty, the SMTP server address will be used by default.
Preference key field
Size of preference key field
Preference owner field
Size of preference owner field
Preference value field
Size of preference key field
Provider name
Here you can set the text of the link displayed on the top-right of the message list.
Defaults to empty (no link).
Provider URI
Here you can set URL of the link displayed on the top-right of the message list.
Defaults to empty (no link).
Templates
You can define your own template set (skin) and put it in a new directory under SM_PATH/templates. The ID must match the name of the template directory as the example below. You can name the template whatever you want. For an example of a template, see the ones included in the SM_PATH/templates directory.
To add a new template to the options that users can choose from, just add a new number to the array at the bottom, and follow the pattern.
$templateset_default sets the skin that will be used by default when a user doesn't have a skin selection in their preferences. (Must be the "ID" of the desired template set)
$templateset_fallback tells SquirrelMail which template set (skin) to use when looking for a file that is not contained within whatever skin is currently being used. (Must be the "ID" of the desired template set)
$rpc_templateset sets the skin that will be used by default when a user is making an RPC request. This does not usually need to be changed, but can be used to change the RPC protocol that is used to respond to RPC requets. (Must be the "ID" of the desired template set and should NOT be a template set that is included in the $aTemplateSet list; PLEASE NOTE that new RPC template sets should always be named "<skin name>_rpc", as SquirrelMail will assume any template sets ending in "_rpc" are intended for its RPC interface only)
Extra sendmail command arguments.
Sets additional sendmail command arguments. Make sure that arguments are supported by your sendmail program. -f argument is added automatically by SquirrelMail scripts. Variable defaults to standard /usr/sbin/sendmail arguments. If you use qmail-inject, nbsmtp or any other sendmail wrapper, which does not support -t and -i arguments, set variable to empty string or use arguments suitable for your mailer.
Path to Sendmail
Program that should be used when sending email. SquirrelMail expects that this program will follow options used by original sendmail (http://www.sendmail.org). Support of -f argument is required.
PHP session name.
Leave this alone unless you know what you are doing.
Alternative Language Names Control
This options allows displaying native language names in language selection box.
Subfolder Format Control
Some IMAP daemons (UW) handle folders weird. They only allow a folder to contain either messages or other folders, not both at the same time. This option controls whether or not to display an option during folder creation. The option toggles which type of folder it should be.
If this option confuses you, just set it to 'true'. You can not hurt anything if it's true, but some servers will respond weird if it's false. (Cyrus works fine whether it's true OR false).
User level prefix control
If you do not wish to give them the option to change this, set it to false. Otherwise, if it is true, they can change the folder prefix to be anything.
Signout page
Rather than going to the signout.php page (which only allows you to sign back in), setting signout_page allows you to sign the user out and then redirect to whatever page you want. For instance, the following would return the user to your home page: $signout_page = '/'; Set to the empty string to continue to use the default signout page.
Your SMTP port number (usually 25).
Your SMTP server (usually the same as the IMAP server).
SMTP authentication mechanism
auth_mech can be either 'none', 'login','plain', 'cram-md5', or 'digest-md5'
Custom SMTP authentication password
IMAP password is used if $smtp_sitewide_user global is set to empty string. Variable is included in main configuration file only from 1.5.2 version. Older versions stored it in config_local.php.
Custom SMTP authentication username
IMAP username is used if variable is set to empty string. Variable is included in main configuration file only from 1.5.2 version. Older versions stored it in config_local.php.
Default language
This is the default language. It is used as a last resort if SquirrelMail can't figure out which language to display. Language names usually consist of language code, undercore symbol and country code
Controls use of time zone libraries
Possible values:
Listing of installed themes
User Themes You can define your own theme and put it in directory in SM_PATH/css/.
You must call it as the example below. You can name the theme whatever you want.
To add a new theme to the options that users can choose from, just add a new number to the array at the bottom, and follow the pattern.
$user_theme_default sets theme that will be used by default
Default send transport
What should be used when sending email. If it is set to false, SquirrelMail will use SMTP server settings. If it is set to true, SquirrelMail will use program defined in $sendmail_path
Iframe sandbox code control
Use iframe to render html emails (temp option used during debuging of new code)
Secure IMAP connection controls
PHP iconv functions control
Use experimental code with php iconv functions when reading messages with different encoding. This code is faster that original SM functions, but it require php with iconv support and works only with some translations.
Don't enable this option if you are not sure about availability of iconv support.
PHP recode functions control
Use experimental code with php recode functions when reading messages with different encoding. This code is faster that original SM functions, but it require php with recode support.
Don't enable this option if you are not sure about availability of recode support.
Secure SMTP connection controls
Special Folder Color Control
Whether or not to use a special color for special folders. If not, special folders will be the same color as the other folders.
Security Image Type
Switches between using a transparent image and one that states "this image has been removed for security reasons"
Documentation generated on Mon, 13 Jan 2020 04:22:12 +0100 by phpDocumentor 1.4.3