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

Last change on this file since b6267dad was b6267dad, checked in by Thomas Bruederli <thomas@…>, 10 months ago

Hide product version on login screen by default

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