4 +-----------------------------------------------------------------------+
5 | Main configuration file |
7 | This file is part of the RoundCube Webmail client |
8 | Copyright (C) 2005, RoundCube Dev. - Switzerland |
9 | Licensed under the GNU GPL |
11 +-----------------------------------------------------------------------+
15 $rcmail_config = array();
18 // system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace
19 $rcmail_config['debug_level'] = 1;
21 // enable caching of messages and mailbox data in the local database.
22 // this is recommended if the IMAP server does not run on the same machine
23 $rcmail_config['enable_caching'] = TRUE;
25 // lifetime of message cache
26 // possible units: s, m, h, d, w
27 $rcmail_config['message_cache_lifetime'] = '10d';
29 // automatically create a new RoundCube user when log-in the first time.
30 // a new user will be created once the IMAP login succeeds.
31 // set to false if only registered users can use this service
32 $rcmail_config['auto_create_user'] = TRUE;
34 // the mail host chosen to perform the log-in
35 // leave blank to show a textbox at login, give a list of hosts
36 // to display a pulldown menu or set one host as string.
37 // To use SSL connection, enter ssl://hostname:993
38 $rcmail_config['default_host'] = '';
40 // TCP port used for IMAP connections
41 $rcmail_config['default_port'] = 143;
43 // Automatically add this domain to user names for login
44 // Only for IMAP servers that require full e-mail addresses for login
45 // Specify an array with 'host' => 'domain' values to support multiple hosts
46 $rcmail_config['username_domain'] = '';
48 // This domain will be used to form e-mail addresses of new users
49 // Specify an array with 'host' => 'domain' values to support multiple hosts
50 $rcmail_config['mail_domain'] = '';
52 // Path to a virtuser table file to resolve user names and e-mail addresses
53 $rcmail_config['virtuser_file'] = '';
55 // Query to resolve user names and e-mail addresses from the database
56 // %u will be replaced with the current username for login.
57 // The query should select the user's e-mail address as first col
58 $rcmail_config['virtuser_query'] = '';
60 // use this host for sending mails.
61 // to use SSL connection, set ssl://smtp.host.com
62 // if left blank, the PHP mail() function is used
63 $rcmail_config['smtp_server'] = '';
65 // SMTP port (default is 25; 465 for SSL)
66 $rcmail_config['smtp_port'] = 25;
68 // SMTP username (if required) if you use %u as the username RoundCube
69 // will use the current username for login
70 $rcmail_config['smtp_user'] = '';
72 // SMTP password (if required) if you use %p as the password RoundCube
73 // will use the current user's password for login
74 $rcmail_config['smtp_pass'] = '';
76 // SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
77 // best server supported one)
78 $rcmail_config['smtp_auth_type'] = '';
81 $rcmail_config['smtp_log'] = TRUE;
83 // these cols are shown in the message list
84 // available cols are: subject, from, to, cc, replyto, date, size, encoding
85 $rcmail_config['list_cols'] = array('subject', 'from', 'date', 'size');
87 // relative path to the skin folder
88 $rcmail_config['skin_path'] = 'skins/default/';
90 // use this folder to store temp files (must be writebale for apache user)
91 $rcmail_config['temp_dir'] = 'temp/';
93 // use this folder to store log files (must be writebale for apache user)
94 $rcmail_config['log_dir'] = 'logs/';
96 // session lifetime in minutes
97 $rcmail_config['session_lifetime'] = 10;
99 // check client IP in session athorization
100 $rcmail_config['ip_check'] = TRUE;
102 // this key is used to encrypt the users imap password which is stored
103 // in the session record (and the client cookie if remember password is enabled).
104 // please provide a string of exactly 24 chars.
105 $rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str';
107 // the default locale setting
108 $rcmail_config['locale_string'] = 'en';
110 // use this format for short date display
111 $rcmail_config['date_short'] = 'D H:i';
113 // use this format for detailed date/time formatting
114 $rcmail_config['date_long'] = 'd.m.Y H:i';
116 // add this user-agent to message headers when sending
117 $rcmail_config['useragent'] = 'RoundCube Webmail/0.1b';
119 // use this name to compose page titles
120 $rcmail_config['product_name'] = 'RoundCube Webmail';
122 // only list folders within this path
123 $rcmail_config['imap_root'] = '';
125 // store draft message is this mailbox
126 // leave blank if draft messages should not be stored
127 $rcmail_config['drafts_mbox'] = 'Drafts';
129 // store spam messages in this mailbox
130 $rcmail_config['junk_mbox'] = 'Junk';
132 // store sent message is this mailbox
133 // leave blank if sent messages should not be stored
134 $rcmail_config['sent_mbox'] = 'Sent';
136 // move messages to this folder when deleting them
137 // leave blank if they should be deleted directly
138 $rcmail_config['trash_mbox'] = 'Trash';
140 // display these folders separately in the mailbox list.
141 // these folders will automatically be created if they do not exist
142 $rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash');
144 // protect the default folders from renames, deletes, and subscription changes
145 $rcmail_config['protect_default_folders'] = TRUE;
147 // Set TRUE if deleted messages should not be displayed
148 // This will make the application run slower
149 $rcmail_config['skip_deleted'] = FALSE;
151 // Set true to Mark deleted messages as read as well as deleted
152 // False means that a message's read status is not affected by marking it as deleted
153 $rcmail_config['read_when_deleted'] = TRUE;
155 // When a Trash folder is not present and a message is deleted, flag
156 // the message for deletion rather than deleting it immediately. Setting this to
157 // false causes deleted messages to be permanantly removed if there is no Trash folder
158 $rcmail_config['flag_for_deletion'] = TRUE;
160 // Make use of the built-in spell checker. It is based on GoogieSpell
161 // which means that the message content will be sent to Google in order to check spelling
162 $rcmail_config['enable_spellcheck'] = TRUE;
164 // path to a text file which will be added to each sent message
165 // paths are relative to the RoundCube root folder
166 $rcmail_config['generic_message_footer'] = '';
168 // this string is used as a delimiter for message headers when sending
169 // leave empty for auto-detection
170 $rcmail_config['mail_header_delimiter'] = NULL;
172 // in order to enable public ldap search, create a config array
173 // like the Verisign example below. if you would like to test,
174 // simply uncomment the Verisign example.
176 * example config for Verisign directory
178 * $rcmail_config['ldap_public']['Verisign'] = array('hosts' => array('directory.verisign.com'),
181 * 'search_fields' => array('Email' => 'mail', 'Name' => 'cn'),
182 * 'name_field' => 'cn',
183 * 'mail_field' => 'mail',
185 * 'fuzzy_search' => 0);
188 // try to load host-specific configuration
189 $rcmail_config['include_host_config'] = FALSE;
192 /***** these settings can be overwritten by user's preferences *****/
194 // show up to X items in list view
195 $rcmail_config['pagesize'] = 40;
197 // use this timezone to display date/time
198 $rcmail_config['timezone'] = 1;
200 // daylight savings are On
201 $rcmail_config['dst_active'] = TRUE;
203 // prefer displaying HTML messages
204 $rcmail_config['prefer_html'] = TRUE;
206 // show pretty dates as standard
207 $rcmail_config['prettydate'] = TRUE;
210 $rcmail_config['message_sort_col'] = 'date';
212 // default sort order
213 $rcmail_config['message_sort_order'] = 'DESC';
215 // list of configuration option names that need to be available in Javascript.
216 $rcmail_config['javascript_config'] = array('read_when_deleted', 'flag_for_deletion');
219 // end of config file