4 +-----------------------------------------------------------------------+
5 | Main configuration file |
7 | This file is part of the RoundCube Webmail client |
8 | Copyright (C) 2005-2008, 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 // Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages
82 // Leave this blank and you will get the server variable 'server_name' or
83 // localhost if that isn't defined.
84 $rcmail_config['smtp_helo_host'] = '';
87 $rcmail_config['smtp_log'] = TRUE;
89 // these cols are shown in the message list
90 // available cols are: subject, from, to, cc, replyto, date, size, encoding
91 $rcmail_config['list_cols'] = array('subject', 'from', 'date', 'size');
93 // relative path to the skin folder
94 $rcmail_config['skin_path'] = 'skins/default/';
96 // includes should be interpreted as PHP files
97 $rcmail_config['skin_include_php'] = FALSE;
99 // use this folder to store temp files (must be writebale for apache user)
100 $rcmail_config['temp_dir'] = 'temp/';
102 // use this folder to store log files (must be writebale for apache user)
103 $rcmail_config['log_dir'] = 'logs/';
105 // session lifetime in minutes
106 $rcmail_config['session_lifetime'] = 10;
108 // check client IP in session athorization
109 $rcmail_config['ip_check'] = false;
111 // Use an additional frequently changing cookie to athenticate user sessions.
112 // There have been problems reported with this feature.
113 $rcmail_config['double_auth'] = false;
115 // this key is used to encrypt the users imap password which is stored
116 // in the session record (and the client cookie if remember password is enabled).
117 // please provide a string of exactly 24 chars.
118 $rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str';
120 // the default locale setting
121 $rcmail_config['locale_string'] = 'en';
123 // use this format for short date display
124 $rcmail_config['date_short'] = 'D H:i';
126 // use this format for detailed date/time formatting
127 $rcmail_config['date_long'] = 'd.m.Y H:i';
129 // use this format for today's date display
130 $rcmail_config['date_today'] = 'H:i';
132 // add this user-agent to message headers when sending
133 $rcmail_config['useragent'] = 'RoundCube Webmail/0.1';
135 // use this name to compose page titles
136 $rcmail_config['product_name'] = 'RoundCube Webmail';
138 // only list folders within this path
139 $rcmail_config['imap_root'] = '';
141 // store draft message is this mailbox
142 // leave blank if draft messages should not be stored
143 $rcmail_config['drafts_mbox'] = 'Drafts';
145 // store spam messages in this mailbox
146 $rcmail_config['junk_mbox'] = 'Junk';
148 // store sent message is this mailbox
149 // leave blank if sent messages should not be stored
150 $rcmail_config['sent_mbox'] = 'Sent';
152 // move messages to this folder when deleting them
153 // leave blank if they should be deleted directly
154 $rcmail_config['trash_mbox'] = 'Trash';
156 // display these folders separately in the mailbox list.
157 // these folders will also be displayed with localized names
158 $rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash');
160 // automatically create the above listed default folders on login
161 $rcmail_config['create_default_folders'] = FALSE;
163 // protect the default folders from renames, deletes, and subscription changes
164 $rcmail_config['protect_default_folders'] = TRUE;
166 // Set TRUE if deleted messages should not be displayed
167 // This will make the application run slower
168 $rcmail_config['skip_deleted'] = FALSE;
170 // Set true to Mark deleted messages as read as well as deleted
171 // False means that a message's read status is not affected by marking it as deleted
172 $rcmail_config['read_when_deleted'] = TRUE;
174 // When a Trash folder is not present and a message is deleted, flag
175 // the message for deletion rather than deleting it immediately. Setting this to
176 // false causes deleted messages to be permanantly removed if there is no Trash folder
177 $rcmail_config['flag_for_deletion'] = TRUE;
179 // Behavior if a received message requests a message delivery notification (read receipt)
180 // 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask)
181 $rcmail_config['mdn_requests'] = 0;
183 // Use this charset as fallback for message decoding
184 $rcmail_config['default_charset'] = 'ISO-8859-1';
186 // Make use of the built-in spell checker. It is based on GoogieSpell.
187 // Since Google only accepts connections over https your PHP installatation
188 // requires to be compiled with Open SSL support
189 $rcmail_config['enable_spellcheck'] = TRUE;
191 // For a locally installed Nox Spell Server, please specify the URI to call it.
192 // Get Nox Spell Server from http://orangoo.com/labs/?page_id=72
193 // Leave empty to use the Google spell checking service, what means
194 // that the message content will be sent to Google in order to check spelling
195 $rcmail_config['spellcheck_uri'] = '';
197 // These languages can be selected for spell checking.
198 // Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch');
199 // Leave empty for default set of Google spell check languages
200 $rcmail_config['spellcheck_languages'] = NULL;
202 // path to a text file which will be added to each sent message
203 // paths are relative to the RoundCube root folder
204 $rcmail_config['generic_message_footer'] = '';
206 // add a received header to outgoing mails containing the creators IP and hostname
207 $rcmail_config['http_received_header'] = false;
209 // this string is used as a delimiter for message headers when sending
210 // leave empty for auto-detection
211 $rcmail_config['mail_header_delimiter'] = NULL;
213 // session domain: .example.org
214 $rcmail_config['session_domain'] = '';
216 // in order to enable public ldap search, create a config array
217 // like the Verisign example below. if you would like to test,
218 // simply uncomment the Verisign example.
220 * example config for Verisign directory
222 * $rcmail_config['ldap_public']['Verisign'] = array(
223 * 'name' => 'Verisign.com',
224 * 'hosts' => array('directory.verisign.com'),
229 * 'ldap_version' => 3, // using LDAPv3
230 * 'search_fields' => array('mail', 'cn'), // fields to search in
231 * 'name_field' => 'cn', // this field represents the contact's name
232 * 'email_field' => 'mail', // this field represents the contact's e-mail
233 * 'surname_field' => 'sn', // this field represents the contact's last name
234 * 'firstname_field' => 'gn', // this field represents the contact's first name
235 * 'scope' => 'sub', // search mode: sub|base|list
236 * 'filter' => '', // used for basic listing (if not empty) and will be &'d with search queries. example: status=act
237 * 'fuzzy_search' => true); // server allows wildcard search
240 // don't allow these settings to be overriden by the user
241 $rcmail_config['dont_override'] = array();
243 // list of configuration option names that need to be available in Javascript.
244 $rcmail_config['javascript_config'] = array('read_when_deleted', 'flag_for_deletion');
246 // try to load host-specific configuration
247 $rcmail_config['include_host_config'] = false;
249 // THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA.
250 // ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING!
251 $rcmail_config['enable_installer'] = false;
254 /***** these settings can be overwritten by user's preferences *****/
256 // show up to X items in list view
257 $rcmail_config['pagesize'] = 40;
259 // use this timezone to display date/time
260 $rcmail_config['timezone'] = intval(date('O'))/100 - date('I');
262 // is daylight saving On?
263 $rcmail_config['dst_active'] = (bool)date('I');
265 // prefer displaying HTML messages
266 $rcmail_config['prefer_html'] = TRUE;
268 // compose html formatted messages by default
269 $rcmail_config['htmleditor'] = FALSE;
271 // show pretty dates as standard
272 $rcmail_config['prettydate'] = TRUE;
275 $rcmail_config['message_sort_col'] = 'date';
277 // default sort order
278 $rcmail_config['message_sort_order'] = 'DESC';
280 // save compose message every 300 seconds (5min)
281 $rcmail_config['draft_autosave'] = 300;
283 // default setting if preview pane is enabled
284 $rcmail_config['preview_pane'] = FALSE;
286 // don't let users set pagesize to more than this value if set
287 $rcmail_config['max_pagesize'] = 200;
289 // mime magic database
290 $rcmail_config['mime_magic'] = '/usr/share/misc/magic';
292 // end of config file