4 +-----------------------------------------------------------------------+
5 | Main configuration file |
7 | This file is part of the RoundCube Webmail client |
8 | Copyright (C) 2005-2009, RoundCube Dev. - Switzerland |
9 | Licensed under the GNU GPL |
11 +-----------------------------------------------------------------------+
15 $rcmail_config = array();
17 // system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace
18 $rcmail_config['debug_level'] = 1;
20 // log driver: 'syslog' or 'file'.
21 $rcmail_config['log_driver'] = 'file';
23 // date format for log entries
24 // (read http://php.net/manual/en/function.date.php for all format characters)
25 $rcmail_config['log_date_format'] = 'd-M-Y H:i:s O';
27 // Syslog ident string to use, if using the 'syslog' log driver.
28 $rcmail_config['syslog_id'] = 'roundcube';
30 // Syslog facility to use, if using the 'syslog' log driver.
31 // For possible values see installer or http://php.net/manual/en/function.openlog.php
32 $rcmail_config['syslog_facility'] = LOG_USER;
34 // use this folder to store log files (must be writeable for apache user)
35 // This is used by the 'file' log driver.
36 $rcmail_config['log_dir'] = 'logs/';
38 // use this folder to store temp files (must be writeable for apache user)
39 $rcmail_config['temp_dir'] = 'temp/';
41 // List of active plugins (in plugins/ directory)
42 $rcmail_config['plugins'] = array();
44 // enable caching of messages and mailbox data in the local database.
45 // this is recommended if the IMAP server does not run on the same machine
46 $rcmail_config['enable_caching'] = TRUE;
48 // lifetime of message cache
49 // possible units: s, m, h, d, w
50 $rcmail_config['message_cache_lifetime'] = '10d';
52 // enforce connections over https
53 // with this option enabled, all non-secure connections will be redirected
54 $rcmail_config['force_https'] = FALSE;
56 // automatically create a new RoundCube user when log-in the first time.
57 // a new user will be created once the IMAP login succeeds.
58 // set to false if only registered users can use this service
59 $rcmail_config['auto_create_user'] = TRUE;
61 // the mail host chosen to perform the log-in
62 // leave blank to show a textbox at login, give a list of hosts
63 // to display a pulldown menu or set one host as string.
64 // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
65 $rcmail_config['default_host'] = '';
67 // TCP port used for IMAP connections
68 $rcmail_config['default_port'] = 143;
70 // IMAP auth type. Can be "auth" (CRAM-MD5), "plain" (PLAIN) or "check" to auto detect.
71 // Optional, defaults to "check"
72 $rcmail_config['imap_auth_type'] = null;
74 // If you know your imap's root directory and its folder delimiter,
75 // you can specify them here. Otherwise they will be determined automatically.
76 $rcmail_config['imap_root'] = null;
77 $rcmail_config['imap_delimiter'] = null;
79 // Automatically add this domain to user names for login
80 // Only for IMAP servers that require full e-mail addresses for login
81 // Specify an array with 'host' => 'domain' values to support multiple hosts
82 $rcmail_config['username_domain'] = '';
84 // This domain will be used to form e-mail addresses of new users
85 // Specify an array with 'host' => 'domain' values to support multiple hosts
86 $rcmail_config['mail_domain'] = '';
88 // Path to a virtuser table file to resolve user names and e-mail addresses
89 $rcmail_config['virtuser_file'] = '';
91 // Query to resolve user names and e-mail addresses from the database
92 // %u will be replaced with the current username for login.
93 // The query should select the user's e-mail address as first column
94 // and optional identity name as second column
95 $rcmail_config['virtuser_query'] = '';
97 // use this host for sending mails.
98 // to use SSL connection, set ssl://smtp.host.com
99 // if left blank, the PHP mail() function is used
100 // Use %h variable as replacement for user's IMAP hostname
101 $rcmail_config['smtp_server'] = '';
103 // SMTP port (default is 25; 465 for SSL)
104 $rcmail_config['smtp_port'] = 25;
106 // SMTP username (if required) if you use %u as the username RoundCube
107 // will use the current username for login
108 $rcmail_config['smtp_user'] = '';
110 // SMTP password (if required) if you use %p as the password RoundCube
111 // will use the current user's password for login
112 $rcmail_config['smtp_pass'] = '';
114 // SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
115 // best server supported one)
116 $rcmail_config['smtp_auth_type'] = '';
119 // Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages
120 // Leave this blank and you will get the server variable 'server_name' or
121 // localhost if that isn't defined.
122 $rcmail_config['smtp_helo_host'] = '';
125 $rcmail_config['smtp_log'] = TRUE;
127 // Log SQL queries to <log_dir>/sql or to syslog
128 $rcmail_config['sql_debug'] = false;
130 // Log IMAP conversation to <log_dir>/imap or to syslog
131 $rcmail_config['imap_debug'] = false;
133 // Log SMTP conversation to <log_dir>/smtp or to syslog
134 $rcmail_config['smtp_debug'] = false;
136 // How many seconds must pass between emails sent by a user
137 $rcmail_config['sendmail_delay'] = 0;
139 // These cols are shown in the message list. Available cols are:
140 // subject, from, to, cc, replyto, date, size, flag, attachment
141 $rcmail_config['list_cols'] = array('subject', 'from', 'date', 'size', 'flag', 'attachment');
143 // Includes should be interpreted as PHP files
144 $rcmail_config['skin_include_php'] = FALSE;
146 // Session lifetime in minutes
147 // must be greater than 'keep_alive'/60
148 $rcmail_config['session_lifetime'] = 10;
150 // check client IP in session athorization
151 $rcmail_config['ip_check'] = false;
153 // Use an additional frequently changing cookie to athenticate user sessions.
154 // There have been problems reported with this feature.
155 $rcmail_config['double_auth'] = false;
157 // this key is used to encrypt the users imap password which is stored
158 // in the session record (and the client cookie if remember password is enabled).
159 // please provide a string of exactly 24 chars.
160 $rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str';
162 // the default locale setting (leave empty for auto-detection)
163 // RFC1766 formatted language name like en_US, de_DE, de_CH, fr_FR, pt_BR
164 $rcmail_config['language'] = null;
166 // use this format for short date display (date or strftime format)
167 $rcmail_config['date_short'] = 'D H:i';
169 // use this format for detailed date/time formatting (date or strftime format)
170 $rcmail_config['date_long'] = 'd.m.Y H:i';
172 // use this format for today's date display (date or strftime format)
173 $rcmail_config['date_today'] = 'H:i';
175 // add this user-agent to message headers when sending
176 $rcmail_config['useragent'] = 'RoundCube Webmail/'.RCMAIL_VERSION;
178 // use this name to compose page titles
179 $rcmail_config['product_name'] = 'RoundCube Webmail';
181 // store draft message is this mailbox
182 // leave blank if draft messages should not be stored
183 $rcmail_config['drafts_mbox'] = 'Drafts';
185 // store spam messages in this mailbox
186 $rcmail_config['junk_mbox'] = 'Junk';
188 // store sent message is this mailbox
189 // leave blank if sent messages should not be stored
190 $rcmail_config['sent_mbox'] = 'Sent';
192 // move messages to this folder when deleting them
193 // leave blank if they should be deleted directly
194 $rcmail_config['trash_mbox'] = 'Trash';
196 // display these folders separately in the mailbox list.
197 // these folders will also be displayed with localized names
198 $rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash');
200 // automatically create the above listed default folders on login
201 $rcmail_config['create_default_folders'] = FALSE;
203 // protect the default folders from renames, deletes, and subscription changes
204 $rcmail_config['protect_default_folders'] = TRUE;
206 // if in your system 0 quota means no limit set this option to TRUE
207 $rcmail_config['quota_zero_as_unlimited'] = FALSE;
209 // Behavior if a received message requests a message delivery notification (read receipt)
210 // 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask)
211 $rcmail_config['mdn_requests'] = 0;
213 // Use this charset as fallback for message decoding
214 $rcmail_config['default_charset'] = 'ISO-8859-1';
216 // Make use of the built-in spell checker. It is based on GoogieSpell.
217 // Since Google only accepts connections over https your PHP installatation
218 // requires to be compiled with Open SSL support
219 $rcmail_config['enable_spellcheck'] = TRUE;
221 // Set the spell checking engine. 'googie' is the default. 'pspell' is also available,
222 // but requires the Pspell extensions. When using Nox Spell Server, also set 'googie' here.
223 $rcmail_config['spellcheck_engine'] = 'googie';
225 // For a locally installed Nox Spell Server, please specify the URI to call it.
226 // Get Nox Spell Server from http://orangoo.com/labs/?page_id=72
227 // Leave empty to use the Google spell checking service, what means
228 // that the message content will be sent to Google in order to check spelling
229 $rcmail_config['spellcheck_uri'] = '';
231 // These languages can be selected for spell checking.
232 // Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch');
233 // Leave empty for default set of available language.
234 $rcmail_config['spellcheck_languages'] = NULL;
236 // path to a text file which will be added to each sent message
237 // paths are relative to the RoundCube root folder
238 $rcmail_config['generic_message_footer'] = '';
240 // add a received header to outgoing mails containing the creators IP and hostname
241 $rcmail_config['http_received_header'] = false;
243 // Whether or not to encrypt the IP address and the host name
244 // these could, in some circles, be considered as sensitive information;
245 // however, for the administrator, these could be invaluable help
246 // when tracking down issues.
247 $rcmail_config['http_received_header_encrypt'] = false;
249 // this string is used as a delimiter for message headers when sending
250 // leave empty for auto-detection
251 $rcmail_config['mail_header_delimiter'] = NULL;
253 // session domain: .example.org
254 $rcmail_config['session_domain'] = '';
256 // This indicates which type of address book to use. Possible choises:
257 // 'sql' (default) and 'ldap'.
258 // If set to 'ldap' then it will look at using the first writable LDAP
259 // address book as the primary address book and it will not display the
260 // SQL address book in the 'Address Book' view.
261 $rcmail_config['address_book_type'] = 'sql';
263 // In order to enable public ldap search, configure an array like the Verisign
264 // example further below. if you would like to test, simply uncomment the example.
265 $rcmail_config['ldap_public'] = array();
268 // If you are going to use LDAP for individual address books, you will need to
269 // set 'user_specific' to true and use the variables to generate the appropriate DNs to access it.
271 // The recommended directory structure for LDAP is to store all the address book entries
272 // under the users main entry, e.g.:
277 // mail=contact@contactdomain
279 // So the base_dn would be uid=%fu,ou=people,o=root
280 // The bind_dn would be the same as based_dn or some super user login.
282 * example config for Verisign directory
284 $rcmail_config['ldap_public']['Verisign'] = array(
285 'name' => 'Verisign.com',
286 'hosts' => array('directory.verisign.com'),
289 'user_specific' => false, // If true the base_dn, bind_dn and bind_pass default to the user's IMAP login.
290 // %fu - The full username provided, assumes the username is an email
291 // address, uses the username_domain value if not an email address.
292 // %u - The username prior to the '@'.
293 // %d - The domain name after the '@'.
297 'writable' => false, // Indicates if we can write to the LDAP directory or not.
298 // If writable is true then these fields need to be populated:
299 // LDAP_Object_Classes, required_fields, LDAP_rdn
300 'LDAP_Object_Classes' => array("top", "inetOrgPerson"), // To create a new contact these are the object classes to specify (or any other classes you wish to use).
301 'required_fields' => array("cn", "sn", "mail"), // The required fields needed to build a new contact as required by the object classes (can include additional fields not required by the object classes).
302 'LDAP_rdn' => 'mail', // The RDN field that is used for new entries, this field needs to be one of the search_fields, the base of base_dn is appended to the RDN to insert into the LDAP directory.
303 'ldap_version' => 3, // using LDAPv3
304 'search_fields' => array('mail', 'cn'), // fields to search in
305 'name_field' => 'cn', // this field represents the contact's name
306 'email_field' => 'mail', // this field represents the contact's e-mail
307 'surname_field' => 'sn', // this field represents the contact's last name
308 'firstname_field' => 'gn', // this field represents the contact's first name
309 'sort' => 'cn', // The field to sort the listing by.
310 'scope' => 'sub', // search mode: sub|base|list
311 'filter' => '', // used for basic listing (if not empty) and will be &'d with search queries. example: status=act
312 'fuzzy_search' => true); // server allows wildcard search
315 // An ordered array of the ids of the addressbooks that should be searched
316 // when populating address autocomplete fields server-side. ex: array('sql','Verisign');
317 $rcmail_config['autocomplete_addressbooks'] = array('sql');
319 // don't allow these settings to be overriden by the user
320 $rcmail_config['dont_override'] = array();
322 // Set identities access level:
323 // 0 - many identities with possibility to edit all params
324 // 1 - many identities with possibility to edit all params but not email address
325 // 2 - one identity with possibility to edit all params
326 // 3 - one identity with possibility to edit all params but not email address
327 $rcmail_config['identities_level'] = 0;
329 // try to load host-specific configuration
330 // see http://trac.roundcube.net/wiki/Howto_Config for more details
331 $rcmail_config['include_host_config'] = false;
333 // don't let users set pagesize to more than this value if set
334 $rcmail_config['max_pagesize'] = 200;
336 // mime magic database
337 $rcmail_config['mime_magic'] = '/usr/share/misc/magic';
340 $rcmail_config['message_sort_col'] = 'date';
342 // default sort order
343 $rcmail_config['message_sort_order'] = 'DESC';
345 // THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA.
346 // ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING!
347 $rcmail_config['enable_installer'] = false;
349 // Log successful logins
350 $rcmail_config['log_logins'] = false;
354 * This setting reflects if mail should be always marked as deleted,
355 * even if moving to "Trash" fails. This is necessary in some setups
356 * because a) people may not have a Trash folder or b) they are over
357 * quota (and Trash is included in the quota).
359 * This is a failover setting for iil_C_Move when a message is moved
362 $rcmail_config['delete_always'] = false;
364 // Minimal value of user's 'keep_alive' setting (in seconds)
365 // Must be less than 'session_lifetime'
366 $rcmail_config['min_keep_alive'] = 60;
368 /***** these settings can be overwritten by user's preferences *****/
370 // skin name: folder from skins/
371 $rcmail_config['skin'] = 'default';
373 // show up to X items in list view
374 $rcmail_config['pagesize'] = 40;
376 // use this timezone to display date/time
377 $rcmail_config['timezone'] = 'auto';
379 // is daylight saving On?
380 $rcmail_config['dst_active'] = (bool)date('I');
382 // prefer displaying HTML messages
383 $rcmail_config['prefer_html'] = TRUE;
385 // display remote inline images
386 // 0 - Never, always ask
387 // 1 - Ask if sender is not in address book
388 // 2 - Always show inline images
389 $rcmail_config['show_images'] = 0;
391 // compose html formatted messages by default
392 $rcmail_config['htmleditor'] = FALSE;
394 // show pretty dates as standard
395 $rcmail_config['prettydate'] = TRUE;
397 // save compose message every 300 seconds (5min)
398 $rcmail_config['draft_autosave'] = 300;
400 // default setting if preview pane is enabled
401 $rcmail_config['preview_pane'] = FALSE;
403 // focus new window if new message arrives
404 $rcmail_config['focus_on_new_message'] = true;
406 // Clear Trash on logout
407 $rcmail_config['logout_purge'] = FALSE;
409 // Compact INBOX on logout
410 $rcmail_config['logout_expunge'] = FALSE;
412 // Display attached images below the message body
413 $rcmail_config['inline_images'] = TRUE;
415 // Encoding of long/non-ascii attachment names:
416 // 0 - Full RFC 2231 compatible
417 // 1 - RFC 2047 for 'name' and RFC 2231 for 'filename' parameter (Thunderbird's default)
418 // 2 - Full 2047 compatible
419 $rcmail_config['mime_param_folding'] = 1;
421 // Set TRUE if deleted messages should not be displayed
422 // This will make the application run slower
423 $rcmail_config['skip_deleted'] = FALSE;
425 // Set true to Mark deleted messages as read as well as deleted
426 // False means that a message's read status is not affected by marking it as deleted
427 $rcmail_config['read_when_deleted'] = TRUE;
429 // Set to TRUE to newer delete messages immediately
430 // Use 'Purge' to remove messages marked as deleted
431 $rcmail_config['flag_for_deletion'] = FALSE;
433 // Default interval for keep-alive/check-recent requests (in seconds)
434 // Must be greater than or equal to 'min_keep_alive' and less than 'session_lifetime'
435 $rcmail_config['keep_alive'] = 60;
437 // If true all folders will be checked for recent messages
438 $rcmail_config['check_all_folders'] = FALSE;
440 // If true, after message delete/move, the next message will be displayed
441 $rcmail_config['display_next'] = FALSE;
443 // end of config file