Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 332 lines (253 sloc) 13.443 kB
4e17e6c @thomascube Initial revision
thomascube authored
1 <?php
2
3 /*
4 +-----------------------------------------------------------------------+
5 | Main configuration file |
6 | |
7 | This file is part of the RoundCube Webmail client |
83ce4bb @thomascube Correct/clarify installation hints
thomascube authored
8 | Copyright (C) 2005-2008, RoundCube Dev. - Switzerland |
52c1f28 @thomascube Minor bugfixes and SMTP support
thomascube authored
9 | Licensed under the GNU GPL |
4e17e6c @thomascube Initial revision
thomascube authored
10 | |
11 +-----------------------------------------------------------------------+
12
13 */
14
15 $rcmail_config = array();
16
17
968bdc7 @thomascube Improved SMTP script for sending mails. Now using the PEAR::Net_SMTP …
thomascube authored
18 // system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace
13c1afb @thomascube Fixed some charset bugs
thomascube authored
19 $rcmail_config['debug_level'] = 1;
4e17e6c @thomascube Initial revision
thomascube authored
20
6dc0269 @thomascube Make message caching configurable
thomascube authored
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;
24
cc95700 @thomascube Added message cache garbage collector
thomascube authored
25 // lifetime of message cache
26 // possible units: s, m, h, d, w
27 $rcmail_config['message_cache_lifetime'] = '10d';
28
7902df4 @thomascube Fixed SSL support; improved Courier compatibility; some visual enhanc…
thomascube authored
29 // automatically create a new RoundCube user when log-in the first time.
7cc38e0 @thomascube Added Finnish, Romanian and Chinese translation
thomascube authored
30 // a new user will be created once the IMAP login succeeds.
4e17e6c @thomascube Initial revision
thomascube authored
31 // set to false if only registered users can use this service
32 $rcmail_config['auto_create_user'] = TRUE;
33
34 // the mail host chosen to perform the log-in
35 // leave blank to show a textbox at login, give a list of hosts
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
36 // to display a pulldown menu or set one host as string.
37 // To use SSL connection, enter ssl://hostname:993
4e17e6c @thomascube Initial revision
thomascube authored
38 $rcmail_config['default_host'] = '';
39
42b1135 @thomascube Several bugfixes and feature improvements
thomascube authored
40 // TCP port used for IMAP connections
41 $rcmail_config['default_port'] = 143;
42
b026c3b @thomascube Make IMAP auth type configurable (#1483825)
thomascube authored
43 // IMAP authentication type (auth, plain) or null to use best server supported one
44 $rcmail_config['imap_auth_type'] = null;
45
0566adc @thomascube Include host-specific configuration file
thomascube authored
46 // Automatically add this domain to user names for login
47 // Only for IMAP servers that require full e-mail addresses for login
48 // Specify an array with 'host' => 'domain' values to support multiple hosts
49 $rcmail_config['username_domain'] = '';
50
977a295 @thomascube Usage of virtusertable; mail_domain for new users; Chinese and Turkis…
thomascube authored
51 // This domain will be used to form e-mail addresses of new users
52 // Specify an array with 'host' => 'domain' values to support multiple hosts
13c1afb @thomascube Fixed some charset bugs
thomascube authored
53 $rcmail_config['mail_domain'] = '';
977a295 @thomascube Usage of virtusertable; mail_domain for new users; Chinese and Turkis…
thomascube authored
54
55 // Path to a virtuser table file to resolve user names and e-mail addresses
56 $rcmail_config['virtuser_file'] = '';
57
f88d417 @thomascube Applied several patches
thomascube authored
58 // Query to resolve user names and e-mail addresses from the database
59 // %u will be replaced with the current username for login.
60 // The query should select the user's e-mail address as first col
61 $rcmail_config['virtuser_query'] = '';
62
4e17e6c @thomascube Initial revision
thomascube authored
63 // use this host for sending mails.
fd8c506 @thomascube SMTPS support and minor bugfixes
thomascube authored
64 // to use SSL connection, set ssl://smtp.host.com
4e17e6c @thomascube Initial revision
thomascube authored
65 // if left blank, the PHP mail() function is used
66 $rcmail_config['smtp_server'] = '';
67
fd8c506 @thomascube SMTPS support and minor bugfixes
thomascube authored
68 // SMTP port (default is 25; 465 for SSL)
968bdc7 @thomascube Improved SMTP script for sending mails. Now using the PEAR::Net_SMTP …
thomascube authored
69 $rcmail_config['smtp_port'] = 25;
70
d206c1f added smtp auth method setting through config file
svncommit authored
71 // SMTP username (if required) if you use %u as the username RoundCube
72 // will use the current username for login
4e17e6c @thomascube Initial revision
thomascube authored
73 $rcmail_config['smtp_user'] = '';
74
d206c1f added smtp auth method setting through config file
svncommit authored
75 // SMTP password (if required) if you use %p as the password RoundCube
76 // will use the current user's password for login
4e17e6c @thomascube Initial revision
thomascube authored
77 $rcmail_config['smtp_pass'] = '';
78
d206c1f added smtp auth method setting through config file
svncommit authored
79 // SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
80 // best server supported one)
81 $rcmail_config['smtp_auth_type'] = '';
82
aca3d25 Make smtp HELO/EHLO hostname configurable (closes #1484067)
svncommit authored
83 // SMTP HELO host
84 // Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages
85 // Leave this blank and you will get the server variable 'server_name' or
86 // localhost if that isn't defined.
87 $rcmail_config['smtp_helo_host'] = '';
88
4e17e6c @thomascube Initial revision
thomascube authored
89 // Log sent messages
90 $rcmail_config['smtp_log'] = TRUE;
91
92 // these cols are shown in the message list
93 // available cols are: subject, from, to, cc, replyto, date, size, encoding
94 $rcmail_config['list_cols'] = array('subject', 'from', 'date', 'size');
95
96 // relative path to the skin folder
97 $rcmail_config['skin_path'] = 'skins/default/';
98
5349b78 Update copyright notice
svncommit authored
99 // includes should be interpreted as PHP files
e9ac143 @thomascube Copy changes from r892 and r903
thomascube authored
100 $rcmail_config['skin_include_php'] = FALSE;
5eee009 @thomascube Allow vars and PHP code in templates; improved page title; fixed #148…
thomascube authored
101
4e17e6c @thomascube Initial revision
thomascube authored
102 // use this folder to store temp files (must be writebale for apache user)
103 $rcmail_config['temp_dir'] = 'temp/';
104
fd8c506 @thomascube SMTPS support and minor bugfixes
thomascube authored
105 // use this folder to store log files (must be writebale for apache user)
106 $rcmail_config['log_dir'] = 'logs/';
107
7902df4 @thomascube Fixed SSL support; improved Courier compatibility; some visual enhanc…
thomascube authored
108 // session lifetime in minutes
109 $rcmail_config['session_lifetime'] = 10;
110
4e17e6c @thomascube Initial revision
thomascube authored
111 // check client IP in session athorization
aad6e2a @thomascube New session authentication, should fix bugs #1483951 and #1484299; te…
thomascube authored
112 $rcmail_config['ip_check'] = false;
113
114 // Use an additional frequently changing cookie to athenticate user sessions.
115 // There have been problems reported with this feature.
116 $rcmail_config['double_auth'] = false;
4e17e6c @thomascube Initial revision
thomascube authored
117
bac7d17 @thomascube Fixed bugs #1364122, #1468895, ticket #1483811 and other minor bugs
thomascube authored
118 // this key is used to encrypt the users imap password which is stored
119 // in the session record (and the client cookie if remember password is enabled).
120 // please provide a string of exactly 24 chars.
121 $rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str';
122
58e3602 @thomascube Bugfixes for encoding and sending with attachments
thomascube authored
123 // the default locale setting
197601e @thomascube Next step: introduce the application class 'rcmail' and get rid of so…
thomascube authored
124 $rcmail_config['language'] = 'en';
4e17e6c @thomascube Initial revision
thomascube authored
125
126 // use this format for short date display
127 $rcmail_config['date_short'] = 'D H:i';
128
129 // use this format for detailed date/time formatting
130 $rcmail_config['date_long'] = 'd.m.Y H:i';
131
8c8b2a4 Allow 12 hour date to display for emails sent today (Doug Mandell).
svncommit authored
132 // use this format for today's date display
133 $rcmail_config['date_today'] = 'H:i';
134
4e17e6c @thomascube Initial revision
thomascube authored
135 // add this user-agent to message headers when sending
b2ff3d4 @thomascube Don't create default folders by default
thomascube authored
136 $rcmail_config['useragent'] = 'RoundCube Webmail/0.1';
4e17e6c @thomascube Initial revision
thomascube authored
137
15a9d1c @thomascube Optimized loading time; added periodic mail check; added EXPUNGE command
thomascube authored
138 // use this name to compose page titles
139 $rcmail_config['product_name'] = 'RoundCube Webmail';
140
4e17e6c @thomascube Initial revision
thomascube authored
141 // only list folders within this path
142 $rcmail_config['imap_root'] = '';
143
1966c53 Added Drafts support (Feature #1326839) (richs)
svncommit authored
144 // store draft message is this mailbox
145 // leave blank if draft messages should not be stored
146 $rcmail_config['drafts_mbox'] = 'Drafts';
147
b4b0817 Workaround for drag-drop using whitespace in FF, Junk emptying, misc …
svncommit authored
148 // store spam messages in this mailbox
149 $rcmail_config['junk_mbox'] = 'Junk';
150
4e17e6c @thomascube Initial revision
thomascube authored
151 // store sent message is this mailbox
152 // leave blank if sent messages should not be stored
153 $rcmail_config['sent_mbox'] = 'Sent';
154
155 // move messages to this folder when deleting them
156 // leave blank if they should be deleted directly
157 $rcmail_config['trash_mbox'] = 'Trash';
158
fa4cd20 @thomascube Several bugfixes; see CHANGELOG for details
thomascube authored
159 // display these folders separately in the mailbox list.
83ce4bb @thomascube Correct/clarify installation hints
thomascube authored
160 // these folders will also be displayed with localized names
4e17e6c @thomascube Initial revision
thomascube authored
161 $rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash');
162
b2ff3d4 @thomascube Don't create default folders by default
thomascube authored
163 // automatically create the above listed default folders on login
164 $rcmail_config['create_default_folders'] = FALSE;
165
c8c1e0e Renameable folders, mail-checking changes, other fixes (richs)
svncommit authored
166 // protect the default folders from renames, deletes, and subscription changes
167 $rcmail_config['protect_default_folders'] = TRUE;
168
3baec23 @thomascube Additional config parameter to show/hide deleted messages
thomascube authored
169 // Set TRUE if deleted messages should not be displayed
170 // This will make the application run slower
171 $rcmail_config['skip_deleted'] = FALSE;
172
4b3af37 Added new delete behavior options.
svncommit authored
173 // Set true to Mark deleted messages as read as well as deleted
174 // False means that a message's read status is not affected by marking it as deleted
175 $rcmail_config['read_when_deleted'] = TRUE;
176
177 // When a Trash folder is not present and a message is deleted, flag
178 // the message for deletion rather than deleting it immediately. Setting this to
179 // false causes deleted messages to be permanantly removed if there is no Trash folder
180 $rcmail_config['flag_for_deletion'] = TRUE;
181
0ea8840 @thomascube Make sending of read receipts configurable
thomascube authored
182 // Behavior if a received message requests a message delivery notification (read receipt)
183 // 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask)
184 $rcmail_config['mdn_requests'] = 0;
185
967b342 @thomascube Disable installer by default; add config option to enable it again
thomascube authored
186 // Use this charset as fallback for message decoding
17b5fb7 @thomascube Add configurable default charset for message decoding
thomascube authored
187 $rcmail_config['default_charset'] = 'ISO-8859-1';
188
9960666 @thomascube Added support for Nox Spell Server; plus small bugfixes
thomascube authored
189 // Make use of the built-in spell checker. It is based on GoogieSpell.
e9ac143 @thomascube Copy changes from r892 and r903
thomascube authored
190 // Since Google only accepts connections over https your PHP installatation
191 // requires to be compiled with Open SSL support
ed5d29f @thomascube Finalized GoogieSpell integration
thomascube authored
192 $rcmail_config['enable_spellcheck'] = TRUE;
193
9960666 @thomascube Added support for Nox Spell Server; plus small bugfixes
thomascube authored
194 // For a locally installed Nox Spell Server, please specify the URI to call it.
195 // Get Nox Spell Server from http://orangoo.com/labs/?page_id=72
196 // Leave empty to use the Google spell checking service, what means
197 // that the message content will be sent to Google in order to check spelling
198 $rcmail_config['spellcheck_uri'] = '';
199
200 // These languages can be selected for spell checking.
201 // Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch');
202 // Leave empty for default set of Google spell check languages
203 $rcmail_config['spellcheck_languages'] = NULL;
204
4b0f65a @thomascube Fixed minor bugs
thomascube authored
205 // path to a text file which will be added to each sent message
206 // paths are relative to the RoundCube root folder
207 $rcmail_config['generic_message_footer'] = '';
208
967b342 @thomascube Disable installer by default; add config option to enable it again
thomascube authored
209 // add a received header to outgoing mails containing the creators IP and hostname
210 $rcmail_config['http_received_header'] = false;
211
4b0f65a @thomascube Fixed minor bugs
thomascube authored
212 // this string is used as a delimiter for message headers when sending
4647e1b @thomascube Started implementing search function
thomascube authored
213 // leave empty for auto-detection
214 $rcmail_config['mail_header_delimiter'] = NULL;
b076a46 @thomascube Finished message sorting and fixed some skin issues
thomascube authored
215
aec82bd @till * introduced session_domain
till authored
216 // session domain: .example.org
217 $rcmail_config['session_domain'] = '';
218
6153e20 @alecpl - Option 'use_SQL_address_book' replaced by 'address_book_type'
alecpl authored
219 // This indicates which type of address book to use. Possible choises:
220 // 'sql' (default) and 'ldap'.
221 // If set to 'ldap' then it will look at using the first writable LDAP
4f9c833 /tmp/out
svncommit authored
222 // address book as the primary address book and it will not display the
223 // SQL address book in the 'Address Book' view.
6153e20 @alecpl - Option 'use_SQL_address_book' replaced by 'address_book_type'
alecpl authored
224 $rcmail_config['address_book_type'] = 'sql';
4f9c833 /tmp/out
svncommit authored
225
226 // In order to enable public ldap search, configure an array like the Verisign
227 // example further below. if you would like to test, simply uncomment the example.
228 //
229 // If you are going to use LDAP for individual address books, you will need to
230 // set 'user_specific' to true and use the variables to generate the appropriate DNs to access it.
231 //
232 // The recommended directory structure for LDAP is to store all the address book entries
233 // under the users main entry, e.g.:
234 //
235 // o=root
236 // ou=people
237 // uid=user@domain
238 // mail=contact@contactdomain
239 //
240 // So the base_dn would be uid=%fu,ou=people,o=root
241 // The bind_dn would be the same as based_dn or some super user login.
eea43f7 better explanation of ldap_public in config file. changed check for l…
svncommit authored
242 /**
f115416 @thomascube Merged branch devel-addressbook from r443 back to trunk
thomascube authored
243 * example config for Verisign directory
eea43f7 better explanation of ldap_public in config file. changed check for l…
svncommit authored
244 *
f115416 @thomascube Merged branch devel-addressbook from r443 back to trunk
thomascube authored
245 * $rcmail_config['ldap_public']['Verisign'] = array(
246 * 'name' => 'Verisign.com',
247 * 'hosts' => array('directory.verisign.com'),
248 * 'port' => 389,
4f9c833 /tmp/out
svncommit authored
249 * 'user_specific' => false, // If true the base_dn, bind_dn and bind_pass default to the user's IMAP login.
250 * // %fu - The full username provided, assumes the username is an email
251 * // address, uses the username_domain value if not an email address.
252 * // %u - The username prior to the '@'.
253 * // %d - The domain name after the '@'.
f115416 @thomascube Merged branch devel-addressbook from r443 back to trunk
thomascube authored
254 * 'base_dn' => '',
e3caaf5 @thomascube Use global filters and bind username/ for Ldap searches (#1484159)
thomascube authored
255 * 'bind_dn' => '',
256 * 'bind_pass' => '',
4f9c833 /tmp/out
svncommit authored
257 * 'writable' => false, // Indicates if we can write to the LDAP directory or not.
258 * // If writable is true then these fields need to be populated:
259 * // LDAP_Object_Classes, required_fields, LDAP_rdn
260 * '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).
261 * '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).
262 * '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.
03b2717 @thomascube Applied patch for LDAP version (#1484552)
thomascube authored
263 * 'ldap_version' => 3, // using LDAPv3
f115416 @thomascube Merged branch devel-addressbook from r443 back to trunk
thomascube authored
264 * 'search_fields' => array('mail', 'cn'), // fields to search in
265 * 'name_field' => 'cn', // this field represents the contact's name
266 * 'email_field' => 'mail', // this field represents the contact's e-mail
6b603da @thomascube LDAP improvements
thomascube authored
267 * 'surname_field' => 'sn', // this field represents the contact's last name
268 * 'firstname_field' => 'gn', // this field represents the contact's first name
4f9c833 /tmp/out
svncommit authored
269 * 'sort' => 'cn', // The field to sort the listing by.
f115416 @thomascube Merged branch devel-addressbook from r443 back to trunk
thomascube authored
270 * 'scope' => 'sub', // search mode: sub|base|list
81355ae @thomascube Correct example filter to work with the changes from r1025
thomascube authored
271 * 'filter' => '', // used for basic listing (if not empty) and will be &'d with search queries. example: status=act
f115416 @thomascube Merged branch devel-addressbook from r443 back to trunk
thomascube authored
272 * 'fuzzy_search' => true); // server allows wildcard search
eea43f7 better explanation of ldap_public in config file. changed check for l…
svncommit authored
273 */
d1d2c4f adding files and modifications for public ldap search
svncommit authored
274
b190970 @thomascube Introducing preview pane and conditional skin tags
thomascube authored
275 // don't allow these settings to be overriden by the user
276 $rcmail_config['dont_override'] = array();
277
9606ffb @thomascube Changed behavior to include host-specific configuration (Bug #1483849)
thomascube authored
278 // try to load host-specific configuration
2ca388d @thomascube Call load_host_config() and add reference to Howto_Config (#1485040)
thomascube authored
279 // see http://trac.roundcube.net/wiki/Howto_Config for more details
967b342 @thomascube Disable installer by default; add config option to enable it again
thomascube authored
280 $rcmail_config['include_host_config'] = false;
281
fe6b7ae @alecpl some options moved outside user preferences section
alecpl authored
282 // don't let users set pagesize to more than this value if set
283 $rcmail_config['max_pagesize'] = 200;
284
285 // mime magic database
286 $rcmail_config['mime_magic'] = '/usr/share/misc/magic';
287
288 // default sort col
289 $rcmail_config['message_sort_col'] = 'date';
290
291 // default sort order
292 $rcmail_config['message_sort_order'] = 'DESC';
293
967b342 @thomascube Disable installer by default; add config option to enable it again
thomascube authored
294 // THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA.
295 // ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING!
296 $rcmail_config['enable_installer'] = false;
9606ffb @thomascube Changed behavior to include host-specific configuration (Bug #1483849)
thomascube authored
297
4e17e6c @thomascube Initial revision
thomascube authored
298 /***** these settings can be overwritten by user's preferences *****/
299
300 // show up to X items in list view
301 $rcmail_config['pagesize'] = 40;
302
303 // use this timezone to display date/time
d7d6638 @thomascube Use server's timezone for defaults (#1484288)
thomascube authored
304 $rcmail_config['timezone'] = intval(date('O'))/100 - date('I');
4e17e6c @thomascube Initial revision
thomascube authored
305
5349b78 Update copyright notice
svncommit authored
306 // is daylight saving On?
d7d6638 @thomascube Use server's timezone for defaults (#1484288)
thomascube authored
307 $rcmail_config['dst_active'] = (bool)date('I');
4647e1b @thomascube Started implementing search function
thomascube authored
308
4e17e6c @thomascube Initial revision
thomascube authored
309 // prefer displaying HTML messages
310 $rcmail_config['prefer_html'] = TRUE;
311
b190970 @thomascube Introducing preview pane and conditional skin tags
thomascube authored
312 // compose html formatted messages by default
45a470a @till * tinymce has some issues (especially in the IE department), enable o…
till authored
313 $rcmail_config['htmleditor'] = FALSE;
b190970 @thomascube Introducing preview pane and conditional skin tags
thomascube authored
314
30233b8 @thomascube Minor bugfixes and correction of confusing License notfications
thomascube authored
315 // show pretty dates as standard
316 $rcmail_config['prettydate'] = TRUE;
317
d656f1c @thomascube Made automatic draft saving configurable
thomascube authored
318 // save compose message every 300 seconds (5min)
319 $rcmail_config['draft_autosave'] = 300;
0566adc @thomascube Include host-specific configuration file
thomascube authored
320
b190970 @thomascube Introducing preview pane and conditional skin tags
thomascube authored
321 // default setting if preview pane is enabled
322 $rcmail_config['preview_pane'] = FALSE;
323
eaa3947 @alecpl #1483863: empty trash and expunge inbox on logout
alecpl authored
324 // Clear Trash on logout
325 $rcmail_config['logout_purge'] = FALSE;
326
327 // Compact INBOX on logout
328 $rcmail_config['logout_expunge'] = FALSE;
329
4e17e6c @thomascube Initial revision
thomascube authored
330 // end of config file
1966c53 Added Drafts support (Feature #1326839) (richs)
svncommit authored
331 ?>
Something went wrong with that request. Please try again.