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

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

Set display_next option to true by default (in config template)

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