/nasmail/config/config_default.php
Default NaSMail 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.
integer
$abook_file_line_length
(line 752)
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).
string
$abook_global_file
(line 723)
Shared filebased address book
bool
$abook_global_file_listing
(line 735)
Listing of shared address book control
bool
$abook_global_file_writeable
(line 729)
Writing into shared address book control
string
$addrbook_global_dsn
(line 807)
DSN of global address book database
boolean
$addrbook_global_listing
(line 822)
Control listing of global database address book
string
$addrbook_global_table
(line 812)
Table used for global database address book
boolean
$addrbook_global_writeable
(line 817)
Control writing into global database address book
bool
$allow_charset_search
(line 616)
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.
boolean
$allow_remote_configtest
(line 858)
Controls remote configuration checks
bool
$allow_server_sort
(line 606)
Server Side Sorting Control
to use server-side sorting instead of SM client side. Your IMAP server must support the SORT extension for this to work.
bool
$allow_thread_sort
(line 596)
Server Side Threading Control
If you want to enable server side thread sorting options Your IMAP server must support the THREAD extension for this to work.
string
$attachment_dir
(line 509)
Attachments directory
Path to directory used for storing attachments while a mail is being sent. There are a few security considerations regarding this directory:
- It should have the permission 733 (rwx-wx-wx) to make it impossible for a random person with access to the webserver to list files in this directory. Confidential data might be laying around there.
- Since the webserver is not able to list the files in the content is also impossible for the webserver to delete files lying around there for too long.
- It should probably be another directory than data_dir.
bool
$auto_create_special
(line 427)
Create Special Folders Control
Should I create the Sent and Trash folders automatically for a new user that doesn't already have them created?
string
$config_location_base
(line 655)
Location base
This is used to build the URL to the NaSMail 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 NaSMail is at http://www.example.net/web/mail/src/login.php, you write: http://www.example.net
integer
$config_use_color
(line 908)
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.
string
$custom_session_handler
(line 899)
Custom session handler
Set it to function that sets required PHP session parameters. NaSMail will execute it before calling session_start(). Function can be loaded with PHP auto_prepend_file option or in config/config_local.php. If custom session support is loaded with PHP auto_prepend_file option, you should make sure that prepended scripts don't activate session, don't output trailing whitespace and don't set any PHP session options outside of function set in $custom_session_handler option. In some cases scripts can destroy session data before starting session and options set outside of $custom_session_handler will be lost.
string
$data_dir
(line 489)
Path to the data/ directory
It is a possible security hole to have a writable directory under the web server's root directory (ex: /home/httpd/html). For this reason, it is possible to put the data directory anywhere you would like. The path name can be absolute or relative (to the config directory). It doesn't matter. Here are two examples:
Absolute: $data_dir = '/usr/local/nasmail/data/';
Relative (to main NaSMail directory): $data_dir = SM_PATH . 'data/';
WARNINGS:
- You must make sure that path contains trailing delimiter.
- Relative paths must use slashes (/) and not backslashes (\).
- Full Windows paths must use slashes or backslashes must be escaped correctly. For example: 'C:\Data' path must be set as 'C:/Data/' or as 'C:\\Data\\'. Standard NaSMail configuration tools are designed to work with slashes. If you use backslashes, don't expect other configuration utilities to handle them correctly.
- If relative path is used, it must be prefixed with SM_PATH constant as in above relative path example.
string
$default_folder_prefix
(line 353)
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.
bool
$default_use_mdn
(line 557)
Delivery Receipts Control
This option enables use of read/delivery receipts by end users.
bool
$default_use_priority
(line 541)
Email Priority Control
This option enables use of email priority flags by end users.
bool
$delete_folder
(line 409)
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.
integer
$dir_hash_level
(line 522)
Hash level used for data directory.
This option allows spliting file based NaSMail user data storage directory into several subfolders. Number from
- to 4 allows allows having up to four subfolder levels.
string
$domain
(line 119)
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 bob@example.com, example.com is the domain.
bool
$edit_name
(line 571)
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_name has no effect unless $edit_identity is false;
string
$encode_header_key
(line 169)
Header encryption
Encryption key allows to remove interface Received: headers from 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 contrib/ directory.
bool
$force_username_lowercase
(line 533)
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.
bool
$frame_border_visible
(line 852)
Frame Border Control
This option allows to hide visible frame border between left and right frame. If option is set to 'false', webmail.php page will fail w3.org page validation.
string
$frame_top
(line 85)
Top frame
By default interface takes up the whole browser window. this option allows you to embed it within sites using frames. Set this to the frame you want it to stay in.
bool
$hide_auth_header
(line 586)
NaSMail 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 NaSMail bug tracker #847107 for more details about it.
bool
$hide_sm_attributions
(line 549)
Attributions Control
This option disables display of provider link
integer
$imapPort
(line 208)
IMAP server port
Port used by your imap server. (Usually 143)
string
$imapServerAddress
(line 200)
IMAP server address
The dns name (or IP address) for your imap server.
string
$imap_auth_mech
(line 283)
IMAP authentication mechanism
auth_mech can be either 'login','plain', 'cram-md5', or 'digest-md5'
string
$imap_server_type
(line 233)
IMAP server type
The type of IMAP server you are running. Valid type are the following (case is important): bincimap courier cyrus dovecot eims exchange hmailserver mercury32 uw other
Please note that only eims, hmailserver and cyrus values change some interface functions. Other values are only informational.
In order to set everything correctly, you should adjust other NaSMail options. These options are listed in doc/presets.txt
bool
$invert_time
(line 130)
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.
bool
$list_special_folders_first
(line 435)
List Special Folders First Control
Whether or not to list the special folders first (true/false).
bool
$mailbox_case_sensitive
(line 457)
Mailbox Case Sensitivity Control
string
$motd
(line 760)
MOTD
This is a message that is displayed immediately after a user logs in.
bool
$no_list_for_subscribe
(line 882)
Subscribe Listing Control
Option disables display of folder subscription options.
boolean
$nsm_disable_cookies
(line 874)
Controls use of cookies
This setting allows to disable storage of session information, password and preferred language information in cookies. Please note that cookieless interface mode violates user password security. It is strongly recommended to keep this setting turned off.
If you turn on this setting, make sure that information stored in session is secure and can't be read by third party. See NaSMail documentation (http://www.nasmail.org/docs/cookies.shtml) for more information about cookieless operation mode.
string
$optional_delimiter
(line 323)
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'.
string
$org_logo
(line 42)
Organization's logo picture (blank if none)
string
$org_logo_height
(line 54)
The height of the logo (0 for default)
string
$org_logo_width
(line 48)
The width of the logo (0 for default)
string
$org_name
(line 36)
Organization's name
string
$org_title
(line 62)
Webmail Title
This is the web page title that appears at the top of the browser window.
bool
$pop_before_smtp
(line 332)
POP before SMTP setting
Do you wish to use POP3 before SMTP? Your server must support this in order for NaSMail to work with it.
string
$provider_name
(line 96)
Provider name
Here you can set name of the link displayed on the right side of main page.
Link will be displayed only if you have $hide_sm_attributions option set to true.
string
$provider_uri
(line 107)
Provider URI
Here you can set URL of the link displayed on the right side of main page.
Link will be displayed only if you have $hide_sm_attributions option set to true.
string
$sasl_auth_delimiter
(line 308)
SASL authentication delimiter
Sets text that separates SASL authorization identity name from authentication identity name. Normal username should not contain this delimiter. Please note that @ is already reserved in digest-md5 authentication method. Use of single non-alphanumeric US-ASCII symbol is recommended. Setting can't be set to NULL (0x00), CR or FF.
If setting is set to empty string, alternative authentication ids are disabled. Setting is set to empty string in default configuration.
If login scripts detect use of alternative authentication id, they remove alternative id information from username and store it in session 'authzid' variable.
Same alternative authentication id is used in IMAP and SMTP authentication. If your setup uses SMTP authentication method that does not match IMAP authentication, alternative ids can break things in SMTP authentication methods that support them.
string
$sendmail_args
(line 192)
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 delivery 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.
string
$sendmail_path
(line 179)
Path to Sendmail
Program that should be used when sending email. Scripts expect that this program will follow options used by original sendmail (http://www.sendmail.org).
string
$session_name
(line 632)
PHP session name.
Leave this alone unless you know what you are doing.
bool
$show_alternative_names
(line 843)
Alternative Language Names Control
This options allows displaying native language names in language selection box.
bool
$show_contain_subfolders_option
(line 451)
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).
bool
$show_prefix_option
(line 363)
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.
string
$signout_page
(line 75)
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.
integer
$smtpPort
(line 152)
Your SMTP port number (usually 25).
string
$smtpServerAddress
(line 147)
Your SMTP server (usually the same as the IMAP server).
string
$smtp_auth_mech
(line 259)
SMTP authentication mechanism
auth_mech can be either 'none', 'login','plain', 'cram-md5', or 'digest-md5'
string
$smtp_sitewide_pass
(line 275)
Custom SMTP authentication password
IMAP password is used if $smtp_sitewide_user global is set to empty string.
string
$smtp_sitewide_user
(line 267)
Custom SMTP authentication username
IMAP username is used if variable is set to empty string.
string
$squirrelmail_default_language
(line 834)
Default language
This is the default language. It is used as a last resort if NaSMail can't figure out which language to display. Language names usually consist of language code, undercore symbol and country code
array
$themes
(line 675)
Indexed array of available themes
string
$theme_css
(line 669)
Sets stylesheet (from theme/css directory) that will be used by default.
integer
$theme_default
(line 663)
Sets theme that will be used by default
bool
$uid_support
(line 624)
IMAP UID control
This option allows you to enable unique identifier (UID) support.
bool
$useSendmail
(line 141)
Default send transport
What should be used when sending email. If it is set to false, message delivery system will use SMTP server settings. If it is set to true, delivery will use program defined in $sendmail_path
bool
$use_imap_tls
(line 242)
Advanced IMAP authentication options control
CRAM-MD5, DIGEST-MD5, Plain, and TLS Set reasonable defaults - you'd never know this was there unless you ask for it
bool
$use_smtp_tls
(line 251)
Advanced SMTP authentication options control
CRAM-MD5, DIGEST-MD5, Plain, and TLS Set reasonable defaults - you'd never know this was there unless you ask for it
bool
$use_special_folder_color
(line 418)
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.
Documentation generated on Sun, 22 Nov 2009 17:36:21 +0200 by phpDocumentor 1.4.3