source: github/config/main.inc.php.dist @ aa9ddf1

HEADcourier-fixdev-browser-capabilitiespdorelease-0.8
Last change on this file since aa9ddf1 was aa9ddf1, checked in by thomascube <thomas@…>, 15 months ago

Describe 'scope' option for LDAP groups in config template

  • Property mode set to 100644
File size: 33.7 KB
Line 
1<?php
2
3/*
4 +-----------------------------------------------------------------------+
5 | Main configuration file                                               |
6 |                                                                       |
7 | This file is part of the Roundcube Webmail client                     |
8 | Copyright (C) 2005-2011, The Roundcube Dev Team                       |
9 |                                                                       |
10 | Licensed under the GNU General Public License version 3 or            |
11 | any later version with exceptions for skins & plugins.                |
12 | See the README file for a full license statement.                     |
13 |                                                                       |
14 +-----------------------------------------------------------------------+
15
16*/
17
18$rcmail_config = array();
19
20// ----------------------------------
21// LOGGING/DEBUGGING
22// ----------------------------------
23
24// system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace
25$rcmail_config['debug_level'] = 1;
26
27// log driver:  'syslog' or 'file'.
28$rcmail_config['log_driver'] = 'file';
29
30// date format for log entries
31// (read http://php.net/manual/en/function.date.php for all format characters) 
32$rcmail_config['log_date_format'] = 'd-M-Y H:i:s O';
33
34// Syslog ident string to use, if using the 'syslog' log driver.
35$rcmail_config['syslog_id'] = 'roundcube';
36
37// Syslog facility to use, if using the 'syslog' log driver.
38// For possible values see installer or http://php.net/manual/en/function.openlog.php
39$rcmail_config['syslog_facility'] = LOG_USER;
40
41// Log sent messages to <log_dir>/sendmail or to syslog
42$rcmail_config['smtp_log'] = true;
43
44// Log successful logins to <log_dir>/userlogins or to syslog
45$rcmail_config['log_logins'] = false;
46
47// Log session authentication errors to <log_dir>/session or to syslog
48$rcmail_config['log_session'] = false;
49
50// Log SQL queries to <log_dir>/sql or to syslog
51$rcmail_config['sql_debug'] = false;
52
53// Log IMAP conversation to <log_dir>/imap or to syslog
54$rcmail_config['imap_debug'] = false;
55
56// Log LDAP conversation to <log_dir>/ldap or to syslog
57$rcmail_config['ldap_debug'] = false;
58
59// Log SMTP conversation to <log_dir>/smtp or to syslog
60$rcmail_config['smtp_debug'] = false;
61
62// ----------------------------------
63// IMAP
64// ----------------------------------
65
66// the mail host chosen to perform the log-in
67// leave blank to show a textbox at login, give a list of hosts
68// to display a pulldown menu or set one host as string.
69// To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
70// Supported replacement variables:
71// %n - http hostname ($_SERVER['SERVER_NAME'])
72// %d - domain (http hostname without the first part)
73// %s - domain name after the '@' from e-mail address provided at login screen
74// For example %n = mail.domain.tld, %d = domain.tld
75$rcmail_config['default_host'] = '';
76
77// TCP port used for IMAP connections
78$rcmail_config['default_port'] = 143;
79
80// IMAP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
81// best server supported one)
82$rcmail_config['imap_auth_type'] = null;
83
84// If you know your imap's folder delimiter, you can specify it here.
85// Otherwise it will be determined automatically
86$rcmail_config['imap_delimiter'] = null;
87
88// If IMAP server doesn't support NAMESPACE extension, but you're
89// using shared folders or personal root folder is non-empty, you'll need to
90// set these options. All can be strings or arrays of strings.
91// Folders need to be ended with directory separator, e.g. "INBOX."
92// (special directory "~" is an exception to this rule)
93// These can be used also to overwrite server's namespaces
94$rcmail_config['imap_ns_personal'] = null;
95$rcmail_config['imap_ns_other']    = null;
96$rcmail_config['imap_ns_shared']   = null;
97
98// By default IMAP capabilities are readed after connection to IMAP server
99// In some cases, e.g. when using IMAP proxy, there's a need to refresh the list
100// after login. Set to True if you've got this case.
101$rcmail_config['imap_force_caps'] = false;
102
103// By default list of subscribed folders is determined using LIST-EXTENDED
104// extension if available. Some servers (dovecot 1.x) returns wrong results
105// for shared namespaces in this case. http://trac.roundcube.net/ticket/1486225
106// Enable this option to force LSUB command usage instead.
107$rcmail_config['imap_force_lsub'] = false;
108
109// IMAP connection timeout, in seconds. Default: 0 (no limit)
110$rcmail_config['imap_timeout'] = 0;
111
112// Optional IMAP authentication identifier to be used as authorization proxy
113$rcmail_config['imap_auth_cid'] = null;
114
115// Optional IMAP authentication password to be used for imap_auth_cid
116$rcmail_config['imap_auth_pw'] = null;
117
118// Type of IMAP indexes cache. Supported values: 'db', 'apc' and 'memcache'.
119$rcmail_config['imap_cache'] = null;
120
121// Enables messages cache. Only 'db' cache is supported.
122$rcmail_config['messages_cache'] = false;
123
124
125// ----------------------------------
126// SMTP
127// ----------------------------------
128
129// SMTP server host (for sending mails).
130// To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
131// If left blank, the PHP mail() function is used
132// Supported replacement variables:
133// %h - user's IMAP hostname
134// %n - http hostname ($_SERVER['SERVER_NAME'])
135// %d - domain (http hostname without the first part)
136// %z - IMAP domain (IMAP hostname without the first part)
137// For example %n = mail.domain.tld, %d = domain.tld
138$rcmail_config['smtp_server'] = '';
139
140// SMTP port (default is 25; use 587 for STARTTLS or 465 for the
141// deprecated SSL over SMTP (aka SMTPS))
142$rcmail_config['smtp_port'] = 25;
143
144// SMTP username (if required) if you use %u as the username Roundcube
145// will use the current username for login
146$rcmail_config['smtp_user'] = '';
147
148// SMTP password (if required) if you use %p as the password Roundcube
149// will use the current user's password for login
150$rcmail_config['smtp_pass'] = '';
151
152// SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
153// best server supported one)
154$rcmail_config['smtp_auth_type'] = '';
155
156// Optional SMTP authentication identifier to be used as authorization proxy
157$rcmail_config['smtp_auth_cid'] = null;
158
159// Optional SMTP authentication password to be used for smtp_auth_cid
160$rcmail_config['smtp_auth_pw'] = null;
161
162// SMTP HELO host
163// Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages
164// Leave this blank and you will get the server variable 'server_name' or
165// localhost if that isn't defined.
166$rcmail_config['smtp_helo_host'] = '';
167
168// SMTP connection timeout, in seconds. Default: 0 (no limit)
169$rcmail_config['smtp_timeout'] = 0;
170
171// ----------------------------------
172// SYSTEM
173// ----------------------------------
174
175// THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA.
176// ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING!
177$rcmail_config['enable_installer'] = false;
178
179// use this folder to store log files (must be writeable for apache user)
180// This is used by the 'file' log driver.
181$rcmail_config['log_dir'] = 'logs/';
182
183// use this folder to store temp files (must be writeable for apache user)
184$rcmail_config['temp_dir'] = 'temp/';
185
186// lifetime of message cache
187// possible units: s, m, h, d, w
188$rcmail_config['message_cache_lifetime'] = '10d';
189
190// enforce connections over https
191// with this option enabled, all non-secure connections will be redirected.
192// set the port for the ssl connection as value of this option if it differs from the default 443
193$rcmail_config['force_https'] = false;
194
195// tell PHP that it should work as under secure connection
196// even if it doesn't recognize it as secure ($_SERVER['HTTPS'] is not set)
197// e.g. when you're running Roundcube behind a https proxy
198$rcmail_config['use_https'] = false;
199
200// Allow browser-autocompletion on login form.
201// 0 - disabled, 1 - username and host only, 2 - username, host, password
202$rcmail_config['login_autocomplete'] = 0;
203
204// If users authentication is not case sensitive this must be enabled.
205// You can also use it to force conversion of logins to lower case.
206// After enabling it all user records need to be updated, e.g. with query:
207// UPDATE users SET username = LOWER(username);
208$rcmail_config['login_lc'] = false;
209
210// automatically create a new Roundcube user when log-in the first time.
211// a new user will be created once the IMAP login succeeds.
212// set to false if only registered users can use this service
213$rcmail_config['auto_create_user'] = true;
214
215// provide an URL where a user can get support for this Roundcube installation
216// PLEASE DO NOT LINK TO THE ROUNDCUBE.NET WEBSITE HERE!
217$rcmail_config['support_url'] = '';
218
219// replace Roundcube logo with this image
220// specify an URL relative to the document root of this Roundcube installation
221$rcmail_config['skin_logo'] = null;
222
223// Includes should be interpreted as PHP files
224$rcmail_config['skin_include_php'] = false;
225
226// Session lifetime in minutes
227// must be greater than 'keep_alive'/60
228$rcmail_config['session_lifetime'] = 10;
229
230// session domain: .example.org
231$rcmail_config['session_domain'] = '';
232
233// session name. Default: 'roundcube_sessid'
234$rcmail_config['session_name'] = null;
235
236// Backend to use for session storage. Can either be 'db' (default) or 'memcache'
237// If set to memcache, a list of servers need to be specified in 'memcache_hosts'
238// Make sure the Memcache extension (http://pecl.php.net/package/memcache) version >= 2.0.0 is installed
239$rcmail_config['session_storage'] = 'db';
240
241// Use these hosts for accessing memcached
242// Define any number of hosts in the form hostname:port
243$rcmail_config['memcache_hosts'] = null; // e.g. array( 'localhost:11211', '192.168.1.12:11211' );
244
245// check client IP in session athorization
246$rcmail_config['ip_check'] = false;
247
248// check referer of incoming requests
249$rcmail_config['referer_check'] = false;
250
251// X-Frame-Options HTTP header value sent to prevent from Clickjacking.
252// Possible values: sameorigin|deny. Set to false in order to disable sending them
253$rcmail_config['x_frame_options'] = 'sameorigin';
254
255// this key is used to encrypt the users imap password which is stored
256// in the session record (and the client cookie if remember password is enabled).
257// please provide a string of exactly 24 chars.
258$rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str';
259
260// Automatically add this domain to user names for login
261// Only for IMAP servers that require full e-mail addresses for login
262// Specify an array with 'host' => 'domain' values to support multiple hosts
263// Supported replacement variables:
264// %h - user's IMAP hostname
265// %n - http hostname ($_SERVER['SERVER_NAME'])
266// %d - domain (http hostname without the first part)
267// %z - IMAP domain (IMAP hostname without the first part)
268// For example %n = mail.domain.tld, %d = domain.tld
269$rcmail_config['username_domain'] = '';
270
271// This domain will be used to form e-mail addresses of new users
272// Specify an array with 'host' => 'domain' values to support multiple hosts
273// Supported replacement variables:
274// %h - user's IMAP hostname
275// %n - http hostname ($_SERVER['SERVER_NAME'])
276// %d - domain (http hostname without the first part)
277// %z - IMAP domain (IMAP hostname without the first part)
278// For example %n = mail.domain.tld, %d = domain.tld
279$rcmail_config['mail_domain'] = '';
280
281// Password charset.
282// Use it if your authentication backend doesn't support UTF-8.
283// Defaults to ISO-8859-1 for backward compatibility
284$rcmail_config['password_charset'] = 'ISO-8859-1';
285
286// How many seconds must pass between emails sent by a user
287$rcmail_config['sendmail_delay'] = 0;
288
289// Maximum number of recipients per message. Default: 0 (no limit)
290$rcmail_config['max_recipients'] = 0;
291
292// Maximum allowednumber of members of an address group. Default: 0 (no limit)
293// If 'max_recipients' is set this value should be less or equal
294$rcmail_config['max_group_members'] = 0;
295
296// add this user-agent to message headers when sending
297$rcmail_config['useragent'] = 'Roundcube Webmail/'.RCMAIL_VERSION;
298
299// use this name to compose page titles
300$rcmail_config['product_name'] = 'Roundcube Webmail';
301
302// try to load host-specific configuration
303// see http://trac.roundcube.net/wiki/Howto_Config for more details
304$rcmail_config['include_host_config'] = false;
305
306// path to a text file which will be added to each sent message
307// paths are relative to the Roundcube root folder
308$rcmail_config['generic_message_footer'] = '';
309
310// path to a text file which will be added to each sent HTML message
311// paths are relative to the Roundcube root folder
312$rcmail_config['generic_message_footer_html'] = '';
313
314// add a received header to outgoing mails containing the creators IP and hostname
315$rcmail_config['http_received_header'] = false;
316
317// Whether or not to encrypt the IP address and the host name
318// these could, in some circles, be considered as sensitive information;
319// however, for the administrator, these could be invaluable help
320// when tracking down issues.
321$rcmail_config['http_received_header_encrypt'] = false;
322
323// This string is used as a delimiter for message headers when sending
324// a message via mail() function. Leave empty for auto-detection
325$rcmail_config['mail_header_delimiter'] = NULL;
326
327// number of chars allowed for line when wrapping text.
328// text wrapping is done when composing/sending messages
329$rcmail_config['line_length'] = 72;
330
331// send plaintext messages as format=flowed
332$rcmail_config['send_format_flowed'] = true;
333
334// don't allow these settings to be overriden by the user
335$rcmail_config['dont_override'] = array();
336
337// Set identities access level:
338// 0 - many identities with possibility to edit all params
339// 1 - many identities with possibility to edit all params but not email address
340// 2 - one identity with possibility to edit all params
341// 3 - one identity with possibility to edit all params but not email address
342$rcmail_config['identities_level'] = 0;
343
344// Mimetypes supported by the browser.
345// attachments of these types will open in a preview window
346// either a comma-separated list or an array: 'text/plain,text/html,text/xml,image/jpeg,image/gif,image/png,application/pdf'
347$rcmail_config['client_mimetypes'] = null;  # null == default
348
349// mime magic database
350$rcmail_config['mime_magic'] = '/usr/share/misc/magic';
351
352// path to imagemagick identify binary
353$rcmail_config['im_identify_path'] = null;
354
355// path to imagemagick convert binary
356$rcmail_config['im_convert_path'] = null;
357
358// maximum size of uploaded contact photos in pixel
359$rcmail_config['contact_photo_size'] = 160;
360
361// Enable DNS checking for e-mail address validation
362$rcmail_config['email_dns_check'] = false;
363
364// ----------------------------------
365// PLUGINS
366// ----------------------------------
367
368// List of active plugins (in plugins/ directory)
369$rcmail_config['plugins'] = array();
370
371// ----------------------------------
372// USER INTERFACE
373// ----------------------------------
374
375// default messages sort column. Use empty value for default server's sorting,
376// or 'arrival', 'date', 'subject', 'from', 'to', 'size', 'cc'
377$rcmail_config['message_sort_col'] = '';
378
379// default messages sort order
380$rcmail_config['message_sort_order'] = 'DESC';
381
382// These cols are shown in the message list. Available cols are:
383// subject, from, to, cc, replyto, date, size, status, flag, attachment, 'priority'
384$rcmail_config['list_cols'] = array('subject', 'status', 'from', 'date', 'size', 'flag', 'attachment');
385
386// the default locale setting (leave empty for auto-detection)
387// RFC1766 formatted language name like en_US, de_DE, de_CH, fr_FR, pt_BR
388$rcmail_config['language'] = null;
389
390// use this format for date display (date or strftime format)
391$rcmail_config['date_format'] = 'Y-m-d';
392
393// give this choice of date formats to the user to select from
394$rcmail_config['date_formats'] = array('Y-m-d', 'd-m-Y', 'Y/m/d', 'm/d/Y', 'd/m/Y', 'd.m.Y', 'j.n.Y');
395
396// use this format for time display (date or strftime format)
397$rcmail_config['time_format'] = 'H:i';
398
399// give this choice of time formats to the user to select from
400$rcmail_config['time_formats'] = array('G:i', 'H:i', 'g:i a', 'h:i A');
401
402// use this format for short date display (derived from date_format and time_format)
403$rcmail_config['date_short'] = 'D H:i';
404
405// use this format for detailed date/time formatting (derived from date_format and time_format)
406$rcmail_config['date_long'] = 'Y-m-d H:i';
407
408// store draft message is this mailbox
409// leave blank if draft messages should not be stored
410// NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
411$rcmail_config['drafts_mbox'] = 'Drafts';
412
413// store spam messages in this mailbox
414// NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
415$rcmail_config['junk_mbox'] = 'Junk';
416
417// store sent message is this mailbox
418// leave blank if sent messages should not be stored
419// NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
420$rcmail_config['sent_mbox'] = 'Sent';
421
422// move messages to this folder when deleting them
423// leave blank if they should be deleted directly
424// NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
425$rcmail_config['trash_mbox'] = 'Trash';
426
427// display these folders separately in the mailbox list.
428// these folders will also be displayed with localized names
429// NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
430$rcmail_config['default_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash');
431
432// automatically create the above listed default folders on first login
433$rcmail_config['create_default_folders'] = false;
434
435// protect the default folders from renames, deletes, and subscription changes
436$rcmail_config['protect_default_folders'] = true;
437
438// if in your system 0 quota means no limit set this option to true
439$rcmail_config['quota_zero_as_unlimited'] = false;
440
441// Make use of the built-in spell checker. It is based on GoogieSpell.
442// Since Google only accepts connections over https your PHP installatation
443// requires to be compiled with Open SSL support
444$rcmail_config['enable_spellcheck'] = true;
445
446// Enables spellchecker exceptions dictionary.
447// Setting it to 'shared' will make the dictionary shared by all users.
448$rcmail_config['spellcheck_dictionary'] = false;
449
450// Set the spell checking engine. 'googie' is the default. 'pspell' is also available,
451// but requires the Pspell extensions. When using Nox Spell Server, also set 'googie' here.
452$rcmail_config['spellcheck_engine'] = 'googie';
453
454// For a locally installed Nox Spell Server, please specify the URI to call it.
455// Get Nox Spell Server from http://orangoo.com/labs/?page_id=72
456// Leave empty to use the Google spell checking service, what means
457// that the message content will be sent to Google in order to check spelling
458$rcmail_config['spellcheck_uri'] = '';
459
460// These languages can be selected for spell checking.
461// Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch');
462// Leave empty for default set of available language.
463$rcmail_config['spellcheck_languages'] = NULL;
464
465// Makes that words with all letters capitalized will be ignored (e.g. GOOGLE)
466$rcmail_config['spellcheck_ignore_caps'] = false;
467
468// Makes that words with numbers will be ignored (e.g. g00gle)
469$rcmail_config['spellcheck_ignore_nums'] = false;
470
471// Makes that words with symbols will be ignored (e.g. g@@gle)
472$rcmail_config['spellcheck_ignore_syms'] = false;
473
474// Use this char/string to separate recipients when composing a new message
475$rcmail_config['recipients_separator'] = ',';
476
477// don't let users set pagesize to more than this value if set
478$rcmail_config['max_pagesize'] = 200;
479
480// Minimal value of user's 'keep_alive' setting (in seconds)
481// Must be less than 'session_lifetime'
482$rcmail_config['min_keep_alive'] = 60;
483
484// Enables files upload indicator. Requires APC installed and enabled apc.rfc1867 option.
485// By default refresh time is set to 1 second. You can set this value to true
486// or any integer value indicating number of seconds.
487$rcmail_config['upload_progress'] = false;
488
489// Specifies for how many seconds the Undo button will be available
490// after object delete action. Currently used with supporting address book sources.
491// Setting it to 0, disables the feature.
492$rcmail_config['undo_timeout'] = 0;
493
494// ----------------------------------
495// ADDRESSBOOK SETTINGS
496// ----------------------------------
497
498// This indicates which type of address book to use. Possible choises:
499// 'sql' (default) and 'ldap'.
500// If set to 'ldap' then it will look at using the first writable LDAP
501// address book as the primary address book and it will not display the
502// SQL address book in the 'Address Book' view.
503$rcmail_config['address_book_type'] = 'sql';
504
505// In order to enable public ldap search, configure an array like the Verisign
506// example further below. if you would like to test, simply uncomment the example.
507// Array key must contain only safe characters, ie. a-zA-Z0-9_
508$rcmail_config['ldap_public'] = array();
509
510// If you are going to use LDAP for individual address books, you will need to
511// set 'user_specific' to true and use the variables to generate the appropriate DNs to access it.
512//
513// The recommended directory structure for LDAP is to store all the address book entries
514// under the users main entry, e.g.:
515//
516//  o=root
517//   ou=people
518//    uid=user@domain
519//  mail=contact@contactdomain
520//
521// So the base_dn would be uid=%fu,ou=people,o=root
522// The bind_dn would be the same as based_dn or some super user login.
523/*
524 * example config for Verisign directory
525 *
526$rcmail_config['ldap_public']['Verisign'] = array(
527  'name'          => 'Verisign.com',
528  // Replacement variables supported in host names:
529  // %h - user's IMAP hostname
530  // %n - http hostname ($_SERVER['SERVER_NAME'])
531  // %d - domain (http hostname without the first part)
532  // %z - IMAP domain (IMAP hostname without the first part)
533  // For example %n = mail.domain.tld, %d = domain.tld
534  'hosts'         => array('directory.verisign.com'),
535  'port'          => 389,
536  'use_tls'           => false,
537  'ldap_version'  => 3,       // using LDAPv3
538  'user_specific' => false,   // If true the base_dn, bind_dn and bind_pass default to the user's IMAP login.
539  // %fu - The full username provided, assumes the username is an email
540  //       address, uses the username_domain value if not an email address.
541  // %u  - The username prior to the '@'.
542  // %d  - The domain name after the '@'.
543  // %dc - The domain name hierarchal string e.g. "dc=test,dc=domain,dc=com"
544  // %dn - DN found by ldap search when search_filter/search_base_dn are used
545  'base_dn'       => '',
546  'bind_dn'       => '',
547  'bind_pass'     => '',
548  // It's possible to bind for an individual address book
549  // The login name is used to search for the DN to bind with
550  'search_base_dn' => '',
551  'search_filter'  => '',   // e.g. '(&(objectClass=posixAccount)(uid=%u))'
552  // DN and password to bind as before searching for bind DN, if anonymous search is not allowed
553  'search_bind_dn' => '',
554  'search_bind_pw' => '',
555  // Default for %dn variable if search doesn't return DN value
556  'search_dn_default' => '',
557  // Optional authentication identifier to be used as SASL authorization proxy
558  // bind_dn need to be empty
559  'auth_cid'       => '',
560  // SASL authentication method (for proxy auth), e.g. DIGEST-MD5
561  'auth_method'    => '',
562  // Indicates if the addressbook shall be hidden from the list.
563  // With this option enabled you can still search/view contacts.
564  'hidden'        => false,
565  // Indicates if the addressbook shall not list contacts but only allows searching.
566  'searchonly'    => false,
567  // Indicates if we can write to the LDAP directory or not.
568  // If writable is true then these fields need to be populated:
569  // LDAP_Object_Classes, required_fields, LDAP_rdn
570  'writable'       => false,
571  // To create a new contact these are the object classes to specify
572  // (or any other classes you wish to use).
573  'LDAP_Object_Classes' => array('top', 'inetOrgPerson'),
574  // The RDN field that is used for new entries, this field needs
575  // to be one of the search_fields, the base of base_dn is appended
576  // to the RDN to insert into the LDAP directory.
577  'LDAP_rdn'       => 'mail',
578  // The required fields needed to build a new contact as required by
579  // the object classes (can include additional fields not required by the object classes).
580  'required_fields' => array('cn', 'sn', 'mail'),
581  'search_fields'   => array('mail', 'cn'),  // fields to search in
582  // mapping of contact fields to directory attributes
583  'fieldmap' => array(
584    // Roundcube  => LDAP
585    'name'        => 'cn',
586    'surname'     => 'sn',
587    'firstname'   => 'givenName',
588    'email'       => 'mail',
589    'phone:home'  => 'homePhone',
590    'phone:work'  => 'telephoneNumber',
591    'phone:mobile' => 'mobile',
592    'street'      => 'street',
593    'zipcode'     => 'postalCode',
594    'locality'    => 'l',
595    'country'     => 'c',
596    'organization' => 'o',
597  ),
598  'sort'          => 'cn',    // The field to sort the listing by.
599  'scope'         => 'sub',   // search mode: sub|base|list
600  'filter'        => '(objectClass=inetOrgPerson)',      // used for basic listing (if not empty) and will be &'d with search queries. example: status=act
601  'fuzzy_search'  => true,    // server allows wildcard search
602  'vlv'           => false,   // Enable Virtual List View to more efficiently fetch paginated data (if server supports it)
603  'numsub_filter' => '(objectClass=organizationalUnit)',   // with VLV, we also use numSubOrdinates to query the total number of records. Set this filter to get all numSubOrdinates attributes for counting
604  'sizelimit'     => '0',     // Enables you to limit the count of entries fetched. Setting this to 0 means no limit.
605  'timelimit'     => '0',     // Sets the number of seconds how long is spend on the search. Setting this to 0 means no limit.
606  'referrals'     => true|false,  // Sets the LDAP_OPT_REFERRALS option. Mostly used in multi-domain Active Directory setups
607
608  // definition for contact groups (uncomment if no groups are supported)
609  // for the groups base_dn, the user replacements %fu, %u, $d and %dc work as for base_dn (see above)
610  // if the groups base_dn is empty, the contact base_dn is used for the groups as well
611  // -> in this case, assure that groups and contacts are separated due to the concernig filters!
612  'groups'        => array(
613    'base_dn'     => '',
614    'scope'       => 'sub',   // search mode: sub|base|list
615    'filter'      => '(objectClass=groupOfNames)',
616    'object_classes' => array("top", "groupOfNames"),
617    'member_attr'  => 'member',   // name of the member attribute, e.g. uniqueMember
618    'name_attr'    => 'cn',       // attribute to be used as group name
619  ),
620);
621*/
622
623// An ordered array of the ids of the addressbooks that should be searched
624// when populating address autocomplete fields server-side. ex: array('sql','Verisign');
625$rcmail_config['autocomplete_addressbooks'] = array('sql');
626
627// The minimum number of characters required to be typed in an autocomplete field
628// before address books will be searched. Most useful for LDAP directories that
629// may need to do lengthy results building given overly-broad searches
630$rcmail_config['autocomplete_min_length'] = 1;
631
632// Number of parallel autocomplete requests.
633// If there's more than one address book, n parallel (async) requests will be created,
634// where each request will search in one address book. By default (0), all address
635// books are searched in one request.
636$rcmail_config['autocomplete_threads'] = 0;
637
638// Max. numer of entries in autocomplete popup. Default: 15.
639$rcmail_config['autocomplete_max'] = 15;
640
641// show address fields in this order
642// available placeholders: {street}, {locality}, {zipcode}, {country}, {region}
643$rcmail_config['address_template'] = '{street}<br/>{locality} {zipcode}<br/>{country} {region}';
644
645// Matching mode for addressbook search (including autocompletion)
646// 0 - partial (*abc*), default
647// 1 - strict (abc)
648// 2 - prefix (abc*)
649// Note: For LDAP sources fuzzy_search must be enabled to use 'partial' or 'prefix' mode
650$rcmail_config['addressbook_search_mode'] = 0;
651
652// ----------------------------------
653// USER PREFERENCES
654// ----------------------------------
655
656// Use this charset as fallback for message decoding
657$rcmail_config['default_charset'] = 'ISO-8859-1';
658
659// skin name: folder from skins/
660$rcmail_config['skin'] = 'default';
661
662// show up to X items in messages list view
663$rcmail_config['mail_pagesize'] = 50;
664
665// show up to X items in contacts list view
666$rcmail_config['addressbook_pagesize'] = 50;
667
668// sort contacts by this col (preferably either one of name, firstname, surname)
669$rcmail_config['addressbook_sort_col'] = 'surname';
670
671// the way how contact names are displayed in the list
672// 0: display name
673// 1: (prefix) firstname middlename surname (suffix)
674// 2: (prefix) surname firstname middlename (suffix)
675// 3: (prefix) surname, firstname middlename (suffix)
676$rcmail_config['addressbook_name_listing'] = 0;
677
678// use this timezone to display date/time
679// valid timezone identifers are listed here: php.net/manual/en/timezones.php
680// 'auto' will use the browser's timezone settings
681$rcmail_config['timezone'] = 'auto';
682
683// prefer displaying HTML messages
684$rcmail_config['prefer_html'] = true;
685
686// display remote inline images
687// 0 - Never, always ask
688// 1 - Ask if sender is not in address book
689// 2 - Always show inline images
690$rcmail_config['show_images'] = 0;
691
692// compose html formatted messages by default
693// 0 - never, 1 - always, 2 - on reply to HTML message only
694$rcmail_config['htmleditor'] = 0;
695
696// show pretty dates as standard
697$rcmail_config['prettydate'] = true;
698
699// save compose message every 300 seconds (5min)
700$rcmail_config['draft_autosave'] = 300;
701
702// default setting if preview pane is enabled
703$rcmail_config['preview_pane'] = false;
704
705// Mark as read when viewed in preview pane (delay in seconds)
706// Set to -1 if messages in preview pane should not be marked as read
707$rcmail_config['preview_pane_mark_read'] = 0;
708
709// Clear Trash on logout
710$rcmail_config['logout_purge'] = false;
711
712// Compact INBOX on logout
713$rcmail_config['logout_expunge'] = false;
714
715// Display attached images below the message body
716$rcmail_config['inline_images'] = true;
717
718// Encoding of long/non-ascii attachment names:
719// 0 - Full RFC 2231 compatible
720// 1 - RFC 2047 for 'name' and RFC 2231 for 'filename' parameter (Thunderbird's default)
721// 2 - Full 2047 compatible
722$rcmail_config['mime_param_folding'] = 1;
723
724// Set true if deleted messages should not be displayed
725// This will make the application run slower
726$rcmail_config['skip_deleted'] = false;
727
728// Set true to Mark deleted messages as read as well as deleted
729// False means that a message's read status is not affected by marking it as deleted
730$rcmail_config['read_when_deleted'] = true;
731
732// Set to true to never delete messages immediately
733// Use 'Purge' to remove messages marked as deleted
734$rcmail_config['flag_for_deletion'] = false;
735
736// Default interval for keep-alive/check-recent requests (in seconds)
737// Must be greater than or equal to 'min_keep_alive' and less than 'session_lifetime'
738$rcmail_config['keep_alive'] = 60;
739
740// If true all folders will be checked for recent messages
741$rcmail_config['check_all_folders'] = false;
742
743// If true, after message delete/move, the next message will be displayed
744$rcmail_config['display_next'] = false;
745
746// 0 - Do not expand threads
747// 1 - Expand all threads automatically
748// 2 - Expand only threads with unread messages
749$rcmail_config['autoexpand_threads'] = 0;
750
751// When replying place cursor above original message (top posting)
752$rcmail_config['top_posting'] = false;
753
754// When replying strip original signature from message
755$rcmail_config['strip_existing_sig'] = true;
756
757// Show signature:
758// 0 - Never
759// 1 - Always
760// 2 - New messages only
761// 3 - Forwards and Replies only
762$rcmail_config['show_sig'] = 1;
763
764// When replying or forwarding place sender's signature above existing message
765$rcmail_config['sig_above'] = false;
766
767// Use MIME encoding (quoted-printable) for 8bit characters in message body
768$rcmail_config['force_7bit'] = false;
769
770// Defaults of the search field configuration.
771// The array can contain a per-folder list of header fields which should be considered when searching
772// The entry with key '*' stands for all folders which do not have a specific list set.
773// Please note that folder names should to be in sync with $rcmail_config['default_folders']
774$rcmail_config['search_mods'] = null;  // Example: array('*' => array('subject'=>1, 'from'=>1), 'Sent' => array('subject'=>1, 'to'=>1));
775
776// Defaults of the addressbook search field configuration.
777$rcmail_config['addressbook_search_mods'] = null;  // Example: array('name'=>1, 'firstname'=>1, 'surname'=>1, 'email'=>1, '*'=>1);
778
779// 'Delete always'
780// This setting reflects if mail should be always deleted
781// when moving to Trash fails. This is necessary in some setups
782// when user is over quota and Trash is included in the quota.
783$rcmail_config['delete_always'] = false;
784
785// Behavior if a received message requests a message delivery notification (read receipt)
786// 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask)
787// 3 = send automatically if sender is in addressbook, otherwise ask the user
788// 4 = send automatically if sender is in addressbook, otherwise ignore
789$rcmail_config['mdn_requests'] = 0;
790
791// Return receipt checkbox default state
792$rcmail_config['mdn_default'] = 0;
793
794// Delivery Status Notification checkbox default state
795$rcmail_config['dsn_default'] = 0;
796
797// Place replies in the folder of the message being replied to
798$rcmail_config['reply_same_folder'] = false;
799
800// Sets default mode of Forward feature to "forward as attachment"
801$rcmail_config['forward_attachment'] = false;
802
803// Defines address book (internal index) to which new contacts will be added
804// By default it is the first writeable addressbook.
805// Note: Use '0' for built-in address book.
806$rcmail_config['default_addressbook'] = null;
807
808// Enables spell checking before sending a message.
809$rcmail_config['spellcheck_before_send'] = false;
810
811// Skip alternative email addresses in autocompletion (show one address per contact)
812$rcmail_config['autocomplete_single'] = false;
813
814// Default font for composed HTML message.
815// Supported values: Andale Mono, Arial, Arial Black, Book Antiqua, Courier New,
816// Georgia, Helvetica, Impact, Tahoma, Terminal, Times New Roman, Trebuchet MS, Verdana
817$rcmail_config['default_font'] = '';
818
819// end of config file
Note: See TracBrowser for help on using the repository browser.