Permalink
Newer
Older
100644 388 lines (297 sloc) 15.3 KB
@thomascube
Sep 25, 2005
1
<?php
2
3
/*
4
+-----------------------------------------------------------------------+
5
| Main configuration file |
6
| |
7
| This file is part of the RoundCube Webmail client |
8
| Copyright (C) 2005-2008, RoundCube Dev. - Switzerland |
9
| Licensed under the GNU GPL |
@thomascube
Sep 25, 2005
10
| |
11
+-----------------------------------------------------------------------+
12
13
*/
14
15
$rcmail_config = array();
16
17
18
// system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace
19
$rcmail_config['debug_level'] = 1;
@thomascube
Sep 25, 2005
20
21
// log driver: 'syslog' or 'file'.
22
$rcmail_config['log_driver'] = 'file';
23
24
// Syslog ident string to use, if using the 'syslog' log driver.
25
$rcmail_config['syslog_id'] = 'roundcube';
26
27
// Syslog facility to use, if using the 'syslog' log driver.
28
// For possible values see installer or http://php.net/manual/en/function.openlog.php
29
$rcmail_config['syslog_facility'] = LOG_USER;
30
31
// use this folder to store log files (must be writeable for apache user)
32
// This is used by the 'file' log driver.
33
$rcmail_config['log_dir'] = 'logs/';
34
35
// use this folder to store temp files (must be writeable for apache user)
36
$rcmail_config['temp_dir'] = 'temp/';
37
38
// enable caching of messages and mailbox data in the local database.
39
// this is recommended if the IMAP server does not run on the same machine
40
$rcmail_config['enable_caching'] = TRUE;
41
42
// lifetime of message cache
43
// possible units: s, m, h, d, w
44
$rcmail_config['message_cache_lifetime'] = '10d';
45
46
// automatically create a new RoundCube user when log-in the first time.
47
// a new user will be created once the IMAP login succeeds.
@thomascube
Sep 25, 2005
48
// set to false if only registered users can use this service
49
$rcmail_config['auto_create_user'] = TRUE;
50
51
// the mail host chosen to perform the log-in
52
// leave blank to show a textbox at login, give a list of hosts
53
// to display a pulldown menu or set one host as string.
54
// To use SSL connection, enter ssl://hostname:993
@thomascube
Sep 25, 2005
55
$rcmail_config['default_host'] = '';
56
57
// TCP port used for IMAP connections
58
$rcmail_config['default_port'] = 143;
59
60
// IMAP auth type. Can be "auth" (CRAM-MD5), "plain" (PLAIN) or "check" to auto detect.
61
// Optional, defaults to "check"
62
$rcmail_config['imap_auth_type'] = null;
63
64
// Automatically add this domain to user names for login
65
// Only for IMAP servers that require full e-mail addresses for login
66
// Specify an array with 'host' => 'domain' values to support multiple hosts
67
$rcmail_config['username_domain'] = '';
68
69
// This domain will be used to form e-mail addresses of new users
70
// Specify an array with 'host' => 'domain' values to support multiple hosts
71
$rcmail_config['mail_domain'] = '';
72
73
// Path to a virtuser table file to resolve user names and e-mail addresses
74
$rcmail_config['virtuser_file'] = '';
75
76
// Query to resolve user names and e-mail addresses from the database
77
// %u will be replaced with the current username for login.
78
// The query should select the user's e-mail address as first col
79
$rcmail_config['virtuser_query'] = '';
80
@thomascube
Sep 25, 2005
81
// use this host for sending mails.
82
// to use SSL connection, set ssl://smtp.host.com
@thomascube
Sep 25, 2005
83
// if left blank, the PHP mail() function is used
84
$rcmail_config['smtp_server'] = '';
85
86
// SMTP port (default is 25; 465 for SSL)
87
$rcmail_config['smtp_port'] = 25;
88
89
// SMTP username (if required) if you use %u as the username RoundCube
90
// will use the current username for login
@thomascube
Sep 25, 2005
91
$rcmail_config['smtp_user'] = '';
92
93
// SMTP password (if required) if you use %p as the password RoundCube
94
// will use the current user's password for login
@thomascube
Sep 25, 2005
95
$rcmail_config['smtp_pass'] = '';
96
97
// SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
98
// best server supported one)
99
$rcmail_config['smtp_auth_type'] = '';
100
101
// SMTP HELO host
102
// Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages
103
// Leave this blank and you will get the server variable 'server_name' or
104
// localhost if that isn't defined.
105
$rcmail_config['smtp_helo_host'] = '';
106
@thomascube
Sep 25, 2005
107
// Log sent messages
108
$rcmail_config['smtp_log'] = TRUE;
109
110
// how many seconds must pass between emails sent by a user
111
$rcmail_config['sendmail_delay'] = 0;
112
@thomascube
Sep 25, 2005
113
// these cols are shown in the message list
114
// available cols are: subject, from, to, cc, replyto, date, size, encoding, flag
115
$rcmail_config['list_cols'] = array('subject', 'from', 'date', 'size', 'flag');
@thomascube
Sep 25, 2005
116
117
// includes should be interpreted as PHP files
118
$rcmail_config['skin_include_php'] = FALSE;
120
// session lifetime in minutes
121
$rcmail_config['session_lifetime'] = 10;
122
@thomascube
Sep 25, 2005
123
// check client IP in session athorization
124
$rcmail_config['ip_check'] = false;
125
126
// Use an additional frequently changing cookie to athenticate user sessions.
127
// There have been problems reported with this feature.
128
$rcmail_config['double_auth'] = false;
@thomascube
Sep 25, 2005
129
130
// this key is used to encrypt the users imap password which is stored
131
// in the session record (and the client cookie if remember password is enabled).
132
// please provide a string of exactly 24 chars.
133
$rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str';
134
135
// the default locale setting (leave empty for auto-detection)
136
// RFC1766 formatted language name like en_US, de_DE, de_CH, fr_FR, pt_BR
137
$rcmail_config['language'] = null;
@thomascube
Sep 25, 2005
138
139
// use this format for short date display
140
$rcmail_config['date_short'] = 'D H:i';
141
142
// use this format for detailed date/time formatting
143
$rcmail_config['date_long'] = 'd.m.Y H:i';
144
145
// use this format for today's date display
146
$rcmail_config['date_today'] = 'H:i';
147
@thomascube
Sep 25, 2005
148
// add this user-agent to message headers when sending
149
$rcmail_config['useragent'] = 'RoundCube Webmail/0.2-beta';
@thomascube
Sep 25, 2005
150
151
// use this name to compose page titles
152
$rcmail_config['product_name'] = 'RoundCube Webmail';
153
@thomascube
Sep 25, 2005
154
// only list folders within this path
155
$rcmail_config['imap_root'] = '';
156
157
// store draft message is this mailbox
158
// leave blank if draft messages should not be stored
159
$rcmail_config['drafts_mbox'] = 'Drafts';
160
161
// store spam messages in this mailbox
162
$rcmail_config['junk_mbox'] = 'Junk';
163
@thomascube
Sep 25, 2005
164
// store sent message is this mailbox
165
// leave blank if sent messages should not be stored
166
$rcmail_config['sent_mbox'] = 'Sent';
167
168
// move messages to this folder when deleting them
169
// leave blank if they should be deleted directly
170
$rcmail_config['trash_mbox'] = 'Trash';
171
172
// display these folders separately in the mailbox list.
173
// these folders will also be displayed with localized names
@thomascube
Sep 25, 2005
174
$rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash');
175
176
// automatically create the above listed default folders on login
177
$rcmail_config['create_default_folders'] = FALSE;
178
179
// protect the default folders from renames, deletes, and subscription changes
180
$rcmail_config['protect_default_folders'] = TRUE;
181
182
// if in your system 0 quota means no limit set this option to TRUE
183
$rcmail_config['quota_zero_as_unlimited'] = FALSE;
184
185
// Behavior if a received message requests a message delivery notification (read receipt)
186
// 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask)
187
$rcmail_config['mdn_requests'] = 0;
188
189
// Use this charset as fallback for message decoding
190
$rcmail_config['default_charset'] = 'ISO-8859-1';
191
192
// Make use of the built-in spell checker. It is based on GoogieSpell.
193
// Since Google only accepts connections over https your PHP installatation
194
// requires to be compiled with Open SSL support
195
$rcmail_config['enable_spellcheck'] = TRUE;
196
197
// Set the spell checking engine. 'googie' is the default. 'pspell' is also available,
198
// but requires the Pspell extensions. When using Nox Spell Server, also set 'googie' here.
199
$rcmail_config['spellcheck_engine'] = 'googie';
200
201
// For a locally installed Nox Spell Server, please specify the URI to call it.
202
// Get Nox Spell Server from http://orangoo.com/labs/?page_id=72
203
// Leave empty to use the Google spell checking service, what means
204
// that the message content will be sent to Google in order to check spelling
205
$rcmail_config['spellcheck_uri'] = '';
206
207
// These languages can be selected for spell checking.
208
// Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch');
209
// Leave empty for default set of Google spell check languages, should be defined
210
// when using local Pspell extension
211
$rcmail_config['spellcheck_languages'] = NULL;
212
@thomascube
Nov 18, 2005
213
// path to a text file which will be added to each sent message
214
// paths are relative to the RoundCube root folder
215
$rcmail_config['generic_message_footer'] = '';
216
217
// add a received header to outgoing mails containing the creators IP and hostname
218
$rcmail_config['http_received_header'] = false;
219
@thomascube
Nov 18, 2005
220
// this string is used as a delimiter for message headers when sending
221
// leave empty for auto-detection
222
$rcmail_config['mail_header_delimiter'] = NULL;
224
// session domain: .example.org
225
$rcmail_config['session_domain'] = '';
226
227
// This indicates which type of address book to use. Possible choises:
228
// 'sql' (default) and 'ldap'.
229
// If set to 'ldap' then it will look at using the first writable LDAP
@thomascube
May 7, 2008
230
// address book as the primary address book and it will not display the
231
// SQL address book in the 'Address Book' view.
232
$rcmail_config['address_book_type'] = 'sql';
@thomascube
May 7, 2008
233
234
// In order to enable public ldap search, configure an array like the Verisign
235
// example further below. if you would like to test, simply uncomment the example.
236
//
237
// If you are going to use LDAP for individual address books, you will need to
238
// set 'user_specific' to true and use the variables to generate the appropriate DNs to access it.
239
//
240
// The recommended directory structure for LDAP is to store all the address book entries
241
// under the users main entry, e.g.:
242
//
243
// o=root
244
// ou=people
245
// uid=user@domain
246
// mail=contact@contactdomain
247
//
248
// So the base_dn would be uid=%fu,ou=people,o=root
249
// The bind_dn would be the same as based_dn or some super user login.
251
* example config for Verisign directory
253
* $rcmail_config['ldap_public']['Verisign'] = array(
254
* 'name' => 'Verisign.com',
255
* 'hosts' => array('directory.verisign.com'),
256
* 'port' => 389,
@thomascube
May 7, 2008
258
* 'user_specific' => false, // If true the base_dn, bind_dn and bind_pass default to the user's IMAP login.
259
* // %fu - The full username provided, assumes the username is an email
260
* // address, uses the username_domain value if not an email address.
261
* // %u - The username prior to the '@'.
262
* // %d - The domain name after the '@'.
264
* 'bind_dn' => '',
265
* 'bind_pass' => '',
@thomascube
May 7, 2008
266
* 'writable' => false, // Indicates if we can write to the LDAP directory or not.
267
* // If writable is true then these fields need to be populated:
268
* // LDAP_Object_Classes, required_fields, LDAP_rdn
269
* '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).
270
* '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).
271
* '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.
272
* 'ldap_version' => 3, // using LDAPv3
273
* 'search_fields' => array('mail', 'cn'), // fields to search in
274
* 'name_field' => 'cn', // this field represents the contact's name
275
* 'email_field' => 'mail', // this field represents the contact's e-mail
@thomascube
Aug 15, 2007
276
* 'surname_field' => 'sn', // this field represents the contact's last name
277
* 'firstname_field' => 'gn', // this field represents the contact's first name
@thomascube
May 7, 2008
278
* 'sort' => 'cn', // The field to sort the listing by.
279
* 'scope' => 'sub', // search mode: sub|base|list
280
* 'filter' => '', // used for basic listing (if not empty) and will be &'d with search queries. example: status=act
281
* 'global_search' => true, // perform a global search for address auto-completion on compose
282
* 'fuzzy_search' => true); // server allows wildcard search
285
// don't allow these settings to be overriden by the user
286
$rcmail_config['dont_override'] = array();
287
288
// allow users to add and delete sender identities
289
$rcmail_config['multiple_identities'] = true;
290
291
// try to load host-specific configuration
292
// see http://trac.roundcube.net/wiki/Howto_Config for more details
293
$rcmail_config['include_host_config'] = false;
294
295
// don't let users set pagesize to more than this value if set
296
$rcmail_config['max_pagesize'] = 200;
297
298
// mime magic database
299
$rcmail_config['mime_magic'] = '/usr/share/misc/magic';
300
301
// default sort col
302
$rcmail_config['message_sort_col'] = 'date';
303
304
// default sort order
305
$rcmail_config['message_sort_order'] = 'DESC';
306
307
// THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA.
308
// ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING!
309
$rcmail_config['enable_installer'] = false;
311
// Log successful logins
312
$rcmail_config['log_logins'] = false;
313
314
/**
315
* 'Delete always'
316
* This setting reflects if mail should be always marked as deleted,
317
* even if moving to "Trash" fails. This is necessary in some setups
318
* because a) people may not have a Trash folder or b) they are over
319
* quota (and Trash is included in the quota).
320
*
321
* This is a failover setting for iil_C_Move when a message is moved
322
* to the Trash, and not the same as "delete_right_away".
323
*/
324
$rcmail_config['delete_always'] = false;
325
@thomascube
Sep 25, 2005
326
/***** these settings can be overwritten by user's preferences *****/
327
328
// skin name: folder from skins/
329
$rcmail_config['skin'] = 'default';
@thomascube
Sep 25, 2005
331
// show up to X items in list view
332
$rcmail_config['pagesize'] = 40;
333
334
// use this timezone to display date/time
335
$rcmail_config['timezone'] = 'auto';
@thomascube
Sep 25, 2005
336
337
// is daylight saving On?
338
$rcmail_config['dst_active'] = (bool)date('I');
@thomascube
Sep 25, 2005
340
// prefer displaying HTML messages
341
$rcmail_config['prefer_html'] = TRUE;
342
343
// display images in mail from known senders
344
$rcmail_config['addrbook_show_images'] = FALSE;
345
346
// compose html formatted messages by default
347
$rcmail_config['htmleditor'] = FALSE;
349
// show pretty dates as standard
350
$rcmail_config['prettydate'] = TRUE;
351
352
// save compose message every 300 seconds (5min)
353
$rcmail_config['draft_autosave'] = 300;
355
// default setting if preview pane is enabled
356
$rcmail_config['preview_pane'] = FALSE;
357
358
// Clear Trash on logout
359
$rcmail_config['logout_purge'] = FALSE;
360
361
// Compact INBOX on logout
362
$rcmail_config['logout_expunge'] = FALSE;
363
364
// Display attached images below the message body
365
$rcmail_config['inline_images'] = TRUE;
367
// Encoding of long/non-ascii attachment names:
368
// 0 - Full RFC 2231 compatible
369
// 1 - RFC 2047 for 'name' and RFC 2231 for 'filename' parameter (Thunderbird's default)
370
// 2 - Full 2047 compatible
371
$rcmail_config['mime_param_folding'] = 0;
372
373
// Set TRUE if deleted messages should not be displayed
374
// This will make the application run slower
375
$rcmail_config['skip_deleted'] = FALSE;
376
377
// Set true to Mark deleted messages as read as well as deleted
378
// False means that a message's read status is not affected by marking it as deleted
379
$rcmail_config['read_when_deleted'] = TRUE;
380
381
// When a Trash folder is not present and a message is deleted, flag
382
// the message for deletion rather than deleting it immediately. Setting this to
383
// false causes deleted messages to be permanantly removed if there is no Trash folder
384
$rcmail_config['flag_for_deletion'] = FALSE;
385
@thomascube
Sep 25, 2005
386
// end of config file