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

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

User configurable setting how to display contact names in list

  • Property mode set to 100644
File size: 33.7 KB
RevLine 
[4e17e6c]1<?php
2
3/*
4 +-----------------------------------------------------------------------+
5 | Main configuration file                                               |
6 |                                                                       |
[e019f2d]7 | This file is part of the Roundcube Webmail client                     |
[62c8618]8 | Copyright (C) 2005-2011, The Roundcube Dev Team                       |
[7fe3811]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.                     |
[4e17e6c]13 |                                                                       |
14 +-----------------------------------------------------------------------+
15
16*/
17
18$rcmail_config = array();
19
[2d08c50f]20// ----------------------------------
21// LOGGING/DEBUGGING
22// ----------------------------------
23
[968bdc7]24// system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace
[13c1afb]25$rcmail_config['debug_level'] = 1;
[4e17e6c]26
[b77d0dd]27// log driver:  'syslog' or 'file'.
28$rcmail_config['log_driver'] = 'file';
29
[0ad27c3]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
[b77d0dd]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
[3e34297]41// Log sent messages to <log_dir>/sendmail or to syslog
[2d08c50f]42$rcmail_config['smtp_log'] = true;
[b77d0dd]43
[3e34297]44// Log successful logins to <log_dir>/userlogins or to syslog
[2d08c50f]45$rcmail_config['log_logins'] = false;
[b77d0dd]46
[fcc7f86]47// Log session authentication errors to <log_dir>/session or to syslog
48$rcmail_config['log_session'] = false;
49
[2d08c50f]50// Log SQL queries to <log_dir>/sql or to syslog
51$rcmail_config['sql_debug'] = false;
[cc97ea0]52
[2d08c50f]53// Log IMAP conversation to <log_dir>/imap or to syslog
54$rcmail_config['imap_debug'] = false;
[6dc0269]55
[2d08c50f]56// Log LDAP conversation to <log_dir>/ldap or to syslog
57$rcmail_config['ldap_debug'] = false;
[cc95700]58
[2d08c50f]59// Log SMTP conversation to <log_dir>/smtp or to syslog
60$rcmail_config['smtp_debug'] = false;
[f5d61d84]61
[2d08c50f]62// ----------------------------------
63// IMAP
64// ----------------------------------
[4e17e6c]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
[42b1135]68// to display a pulldown menu or set one host as string.
[f86e8f5f]69// To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
[bb8721aa]70// Supported replacement variables:
71// %n - http hostname ($_SERVER['SERVER_NAME'])
72// %d - domain (http hostname without the first part)
[b04c51f]73// %s - domain name after the '@' from e-mail address provided at login screen
[bb8721aa]74// For example %n = mail.domain.tld, %d = domain.tld
[4e17e6c]75$rcmail_config['default_host'] = '';
76
[42b1135]77// TCP port used for IMAP connections
78$rcmail_config['default_port'] = 143;
79
[4dd4172]80// IMAP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
81// best server supported one)
[b026c3b]82$rcmail_config['imap_auth_type'] = null;
83
[00290a6]84// If you know your imap's folder delimiter, you can specify it here.
85// Otherwise it will be determined automatically
[030c848]86$rcmail_config['imap_delimiter'] = null;
87
[00290a6]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.
[e3af1f2]91// Folders need to be ended with directory separator, e.g. "INBOX."
92// (special directory "~" is an exception to this rule)
[02491a9]93// These can be used also to overwrite server's namespaces
[00290a6]94$rcmail_config['imap_ns_personal'] = null;
95$rcmail_config['imap_ns_other']    = null;
96$rcmail_config['imap_ns_shared']   = null;
97
[d8c440c]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
[f75f65c]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
[f07d238]109// IMAP connection timeout, in seconds. Default: 0 (no limit)
110$rcmail_config['imap_timeout'] = 0;
111
[a1fe6bd]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
[8edb3d9]118// Type of IMAP indexes cache. Supported values: 'db', 'apc' and 'memcache'.
[5cf5ee6]119$rcmail_config['imap_cache'] = null;
120
121// Enables messages cache. Only 'db' cache is supported.
122$rcmail_config['messages_cache'] = false;
123
124
[2d08c50f]125// ----------------------------------
126// SMTP
127// ----------------------------------
[f88d417]128
[c3b6763]129// SMTP server host (for sending mails).
[2d08c50f]130// To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
[c3b6763]131// If left blank, the PHP mail() function is used
[bb8721aa]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)
[11be933]136// %z - IMAP domain (IMAP hostname without the first part)
[bb8721aa]137// For example %n = mail.domain.tld, %d = domain.tld
[4e17e6c]138$rcmail_config['smtp_server'] = '';
139
[e52aaee]140// SMTP port (default is 25; use 587 for STARTTLS or 465 for the
141// deprecated SSL over SMTP (aka SMTPS))
[968bdc7]142$rcmail_config['smtp_port'] = 25;
143
[e019f2d]144// SMTP username (if required) if you use %u as the username Roundcube
[d206c1f]145// will use the current username for login
[4e17e6c]146$rcmail_config['smtp_user'] = '';
147
[e019f2d]148// SMTP password (if required) if you use %p as the password Roundcube
[d206c1f]149// will use the current user's password for login
[4e17e6c]150$rcmail_config['smtp_pass'] = '';
151
[d206c1f]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
[63d4d611]156// Optional SMTP authentication identifier to be used as authorization proxy
157$rcmail_config['smtp_auth_cid'] = null;
158
[a1fe6bd]159// Optional SMTP authentication password to be used for smtp_auth_cid
[63d4d611]160$rcmail_config['smtp_auth_pw'] = null;
[a392125]161
[aca3d25]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
[f07d238]168// SMTP connection timeout, in seconds. Default: 0 (no limit)
169$rcmail_config['smtp_timeout'] = 0;
170
[2d08c50f]171// ----------------------------------
172// SYSTEM
173// ----------------------------------
[64608bf]174
[2d08c50f]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;
[4e17e6c]178
[2d08c50f]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/';
[d559cba]182
[2d08c50f]183// use this folder to store temp files (must be writeable for apache user)
184$rcmail_config['temp_dir'] = 'temp/';
[d559cba]185
[2d08c50f]186// lifetime of message cache
187// possible units: s, m, h, d, w
188$rcmail_config['message_cache_lifetime'] = '10d';
[19862b55]189
[2d08c50f]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;
[00e18b7]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;
[acb08f5]199
[1cca4fb]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;
[fbe24e9]203
[e17553d]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.
[caedd52]206// After enabling it all user records need to be updated, e.g. with query:
207// UPDATE users SET username = LOWER(username);
[e17553d]208$rcmail_config['login_lc'] = false;
209
[e019f2d]210// automatically create a new Roundcube user when log-in the first time.
[2d08c50f]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;
[4e17e6c]214
[ce22f1e]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
[ae39c47]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
[95d90f8]223// Includes should be interpreted as PHP files
[2d08c50f]224$rcmail_config['skin_include_php'] = false;
[5eee009]225
[95d90f8]226// Session lifetime in minutes
227// must be greater than 'keep_alive'/60
[7902df4]228$rcmail_config['session_lifetime'] = 10;
229
[cf2da2f]230// session domain: .example.org
231$rcmail_config['session_domain'] = '';
232
[bd34cad]233// session name. Default: 'roundcube_sessid'
234$rcmail_config['session_name'] = null;
235
[63e9927]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
[4e17e6c]245// check client IP in session athorization
[aad6e2a]246$rcmail_config['ip_check'] = false;
247
[a77cf22]248// check referer of incoming requests
249$rcmail_config['referer_check'] = false;
250
[c170bfc]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
[67eecde]253$rcmail_config['x_frame_options'] = 'sameorigin';
[c170bfc]254
[bac7d17]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
[2d08c50f]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
[6a642d1]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)
[11be933]267// %z - IMAP domain (IMAP hostname without the first part)
[6a642d1]268// For example %n = mail.domain.tld, %d = domain.tld
[2d08c50f]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
[bb8721aa]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)
[11be933]277// %z - IMAP domain (IMAP hostname without the first part)
[bb8721aa]278// For example %n = mail.domain.tld, %d = domain.tld
[2d08c50f]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
[751b22b]289// Maximum number of recipients per message. Default: 0 (no limit)
290$rcmail_config['max_recipients'] = 0;
291
[d1851ba]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
[2d08c50f]296// add this user-agent to message headers when sending
[6b6f2e8]297$rcmail_config['useragent'] = 'Roundcube Webmail/'.RCMAIL_VERSION;
[2d08c50f]298
299// use this name to compose page titles
[6b6f2e8]300$rcmail_config['product_name'] = 'Roundcube Webmail';
[2d08c50f]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
[e019f2d]307// paths are relative to the Roundcube root folder
[2d08c50f]308$rcmail_config['generic_message_footer'] = '';
309
[5852c14d]310// path to a text file which will be added to each sent HTML message
[e019f2d]311// paths are relative to the Roundcube root folder
[5852c14d]312$rcmail_config['generic_message_footer_html'] = '';
313
[2d08c50f]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
[ac8edbe]323// This string is used as a delimiter for message headers when sending
324// a message via mail() function. Leave empty for auto-detection
[2d08c50f]325$rcmail_config['mail_header_delimiter'] = NULL;
326
[6b6f2e8]327// number of chars allowed for line when wrapping text.
328// text wrapping is done when composing/sending messages
[c769c66]329$rcmail_config['line_length'] = 72;
[6b6f2e8]330
331// send plaintext messages as format=flowed
332$rcmail_config['send_format_flowed'] = true;
333
[2d08c50f]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
[f7b58af]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
[2d08c50f]349// mime magic database
350$rcmail_config['mime_magic'] = '/usr/share/misc/magic';
351
[0501b63]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
[2d08c50f]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
[f52c936f]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'] = '';
[2d08c50f]378
[f52c936f]379// default messages sort order
[2d08c50f]380$rcmail_config['message_sort_order'] = 'DESC';
381
382// These cols are shown in the message list. Available cols are:
[7a2bade]383// subject, from, to, cc, replyto, date, size, status, flag, attachment, 'priority'
[4438d667]384$rcmail_config['list_cols'] = array('subject', 'status', 'from', 'date', 'size', 'flag', 'attachment');
[2d08c50f]385
[c8ae249]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;
[4e17e6c]389
[1cc9e21]390// use this format for date display (date or strftime format)
391$rcmail_config['date_format'] = 'Y-m-d';
[4e17e6c]392
[1cc9e21]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');
[4e17e6c]395
[1cc9e21]396// use this format for time display (date or strftime format)
397$rcmail_config['time_format'] = 'H:i';
[8c8b2a4]398
[1cc9e21]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';
[0501b63]407
[1966c53]408// store draft message is this mailbox
409// leave blank if draft messages should not be stored
[d08333e]410// NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
[1966c53]411$rcmail_config['drafts_mbox'] = 'Drafts';
412
[b4b0817]413// store spam messages in this mailbox
[d08333e]414// NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
[b4b0817]415$rcmail_config['junk_mbox'] = 'Junk';
416
[4e17e6c]417// store sent message is this mailbox
418// leave blank if sent messages should not be stored
[d08333e]419// NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
[4e17e6c]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
[d08333e]424// NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
[4e17e6c]425$rcmail_config['trash_mbox'] = 'Trash';
426
[fa4cd20]427// display these folders separately in the mailbox list.
[83ce4bb]428// these folders will also be displayed with localized names
[d08333e]429// NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
[4e17e6c]430$rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash');
431
[95ebcd91]432// automatically create the above listed default folders on first login
[2d08c50f]433$rcmail_config['create_default_folders'] = false;
[b2ff3d4]434
[c8c1e0ef]435// protect the default folders from renames, deletes, and subscription changes
[2d08c50f]436$rcmail_config['protect_default_folders'] = true;
[c8c1e0ef]437
[2d08c50f]438// if in your system 0 quota means no limit set this option to true
439$rcmail_config['quota_zero_as_unlimited'] = false;
[876b15d]440
[9960666]441// Make use of the built-in spell checker. It is based on GoogieSpell.
[e9ac143]442// Since Google only accepts connections over https your PHP installatation
443// requires to be compiled with Open SSL support
[2d08c50f]444$rcmail_config['enable_spellcheck'] = true;
[ed5d29f]445
[66df084]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
[5d2b7fd]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
[9960666]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');
[01a8c54]462// Leave empty for default set of available language.
[9960666]463$rcmail_config['spellcheck_languages'] = NULL;
464
[66df084]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
[62c8618]474// Use this char/string to separate recipients when composing a new message
475$rcmail_config['recipients_separator'] = ',';
476
[2d08c50f]477// don't let users set pagesize to more than this value if set
478$rcmail_config['max_pagesize'] = 200;
[967b342]479
[2d08c50f]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;
[b076a46]483
[4171c59]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
[63fda8a]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
[2d08c50f]494// ----------------------------------
495// ADDRESSBOOK SETTINGS
496// ----------------------------------
[aec82bd]497
[6153e20]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
[4f9c833]501// address book as the primary address book and it will not display the
502// SQL address book in the 'Address Book' view.
[6153e20]503$rcmail_config['address_book_type'] = 'sql';
[4f9c833]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.
[ecf295f]507// Array key must contain only safe characters, ie. a-zA-Z0-9_
[5f25a1a]508$rcmail_config['ldap_public'] = array();
509
[4f9c833]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
[3b9a53f]519//  mail=contact@contactdomain
520//
[4f9c833]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.
[3b9a53f]523/*
[f115416]524 * example config for Verisign directory
[eea43f7]525 *
[3b9a53f]526$rcmail_config['ldap_public']['Verisign'] = array(
527  'name'          => 'Verisign.com',
[bb8721aa]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)
[11be933]532  // %z - IMAP domain (IMAP hostname without the first part)
[bb8721aa]533  // For example %n = mail.domain.tld, %d = domain.tld
[3b9a53f]534  'hosts'         => array('directory.verisign.com'),
535  'port'          => 389,
[1148c6e]536  'use_tls'           => false,
[0c52106]537  'ldap_version'  => 3,       // using LDAPv3
[3b9a53f]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 '@'.
[f767654]543  // %dc - The domain name hierarchal string e.g. "dc=test,dc=domain,dc=com"
[1148c6e]544  // %dn - DN found by ldap search when search_filter/search_base_dn are used
[3b9a53f]545  'base_dn'       => '',
546  'bind_dn'       => '',
547  'bind_pass'     => '',
[1148c6e]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))'
[2d08ec91]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' => '',
[c041d57]555  // Default for %dn variable if search doesn't return DN value
556  'search_dn_default' => '',
[4d982d3]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'    => '',
[2d3e2bc]562  // Indicates if the addressbook shall be hidden from the list.
[5c9d1ff]563  // With this option enabled you can still search/view contacts.
564  'hidden'        => false,
[2d3e2bc]565  // Indicates if the addressbook shall not list contacts but only allows searching.
566  'searchonly'    => false,
[0c52106]567  // Indicates if we can write to the LDAP directory or not.
[3b9a53f]568  // If writable is true then these fields need to be populated:
569  // LDAP_Object_Classes, required_fields, LDAP_rdn
[0c52106]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(
[0501b63]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  ),
[3b9a53f]598  'sort'          => 'cn',    // The field to sort the listing by.
599  'scope'         => 'sub',   // search mode: sub|base|list
[d1e08fc]600  'filter'        => '(objectClass=inetOrgPerson)',      // used for basic listing (if not empty) and will be &'d with search queries. example: status=act
[6506010]601  'fuzzy_search'  => true,    // server allows wildcard search
[15d7627]602  'vlv'           => false,   // Enable Virtual List View to more efficiently fetch paginated data (if server supports it)
[6af7e0d]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
[6039aae]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.
[3b4b03d]606  'referrals'     => true|false,  // Sets the LDAP_OPT_REFERRALS option. Mostly used in multi-domain Active Directory setups
[d1e08fc]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
[15d7627]611  // -> in this case, assure that groups and contacts are separated due to the concernig filters!
[6039aae]612  'groups'        => array(
[f763fbd]613    'base_dn'     => '',
[6039aae]614    'filter'      => '(objectClass=groupOfNames)',
[d1e08fc]615    'object_classes' => array("top", "groupOfNames"),
[ad27eb2]616    'member_attr'  => 'member',   // name of the member attribute, e.g. uniqueMember
617    'name_attr'    => 'cn',       // attribute to be used as group name
[6039aae]618  ),
[93c01888]619);
[3b9a53f]620*/
[d1d2c4f]621
[2c8e84c]622// An ordered array of the ids of the addressbooks that should be searched
623// when populating address autocomplete fields server-side. ex: array('sql','Verisign');
624$rcmail_config['autocomplete_addressbooks'] = array('sql');
625
[c296b81]626// The minimum number of characters required to be typed in an autocomplete field
627// before address books will be searched. Most useful for LDAP directories that
628// may need to do lengthy results building given overly-broad searches
629$rcmail_config['autocomplete_min_length'] = 1;
630
[0213f8d]631// Number of parallel autocomplete requests.
632// If there's more than one address book, n parallel (async) requests will be created,
633// where each request will search in one address book. By default (0), all address
634// books are searched in one request.
635$rcmail_config['autocomplete_threads'] = 0;
636
637// Max. numer of entries in autocomplete popup. Default: 15.
638$rcmail_config['autocomplete_max'] = 15;
639
[0501b63]640// show address fields in this order
641// available placeholders: {street}, {locality}, {zipcode}, {country}, {region}
642$rcmail_config['address_template'] = '{street}<br/>{locality} {zipcode}<br/>{country} {region}';
643
[f21a04c]644// Matching mode for addressbook search (including autocompletion)
645// 0 - partial (*abc*), default
646// 1 - strict (abc)
647// 2 - prefix (abc*)
648// Note: For LDAP sources fuzzy_search must be enabled to use 'partial' or 'prefix' mode
649$rcmail_config['addressbook_search_mode'] = 0;
650
[2d08c50f]651// ----------------------------------
652// USER PREFERENCES
653// ----------------------------------
[4e17e6c]654
[e55ab02]655// Use this charset as fallback for message decoding
656$rcmail_config['default_charset'] = 'ISO-8859-1';
657
[67effe9]658// skin name: folder from skins/
659$rcmail_config['skin'] = 'default';
[e58df3a]660
[08ffd939]661// show up to X items in messages list view
662$rcmail_config['mail_pagesize'] = 50;
663
664// show up to X items in contacts list view
665$rcmail_config['addressbook_pagesize'] = 50;
[4e17e6c]666
[4387537]667// sort contacts by this col (preferably either one of name, firstname, surname)
668$rcmail_config['addressbook_sort_col'] = 'surname';
669
[f9a9677]670// the way how contact names are displayed in the list
671// 0: display name
672// 1: (prefix) firstname middlename surname (suffix)
673// 2: (prefix) surname firstname middlename (suffix)
674// 3: (prefix) surname, firstname middlename (suffix)
675$rcmail_config['addressbook_name_listing'] = 0;
676
[4e17e6c]677// use this timezone to display date/time
[5879c09]678// valid timezone identifers are listed here: php.net/manual/en/timezones.php
679// 'auto' will use the browser's timezone settings
[c8ae249]680$rcmail_config['timezone'] = 'auto';
[4e17e6c]681
682// prefer displaying HTML messages
[2d08c50f]683$rcmail_config['prefer_html'] = true;
[4e17e6c]684
[2a41355]685// display remote inline images
686// 0 - Never, always ask
687// 1 - Ask if sender is not in address book
688// 2 - Always show inline images
689$rcmail_config['show_images'] = 0;
[712b30d]690
[b190970]691// compose html formatted messages by default
[868deb5]692// 0 - never, 1 - always, 2 - on reply to HTML message only
693$rcmail_config['htmleditor'] = 0;
[b190970]694
[30233b8]695// show pretty dates as standard
[2d08c50f]696$rcmail_config['prettydate'] = true;
[30233b8]697
[d656f1c]698// save compose message every 300 seconds (5min)
699$rcmail_config['draft_autosave'] = 300;
[0566adc]700
[b190970]701// default setting if preview pane is enabled
[2d08c50f]702$rcmail_config['preview_pane'] = false;
[b190970]703
[bc49601]704// Mark as read when viewed in preview pane (delay in seconds)
705// Set to -1 if messages in preview pane should not be marked as read
706$rcmail_config['preview_pane_mark_read'] = 0;
707
[eaa3947]708// Clear Trash on logout
[2d08c50f]709$rcmail_config['logout_purge'] = false;
[eaa3947]710
711// Compact INBOX on logout
[2d08c50f]712$rcmail_config['logout_expunge'] = false;
[eaa3947]713
[166b615]714// Display attached images below the message body
[2d08c50f]715$rcmail_config['inline_images'] = true;
[5e0045b]716
[ffae15e5]717// Encoding of long/non-ascii attachment names:
718// 0 - Full RFC 2231 compatible
719// 1 - RFC 2047 for 'name' and RFC 2231 for 'filename' parameter (Thunderbird's default)
720// 2 - Full 2047 compatible
[21c277e]721$rcmail_config['mime_param_folding'] = 1;
[ffae15e5]722
[2d08c50f]723// Set true if deleted messages should not be displayed
[2b58528]724// This will make the application run slower
[2d08c50f]725$rcmail_config['skip_deleted'] = false;
[2b58528]726
727// Set true to Mark deleted messages as read as well as deleted
728// False means that a message's read status is not affected by marking it as deleted
[2d08c50f]729$rcmail_config['read_when_deleted'] = true;
[2b58528]730
[ca8a178]731// Set to true to never delete messages immediately
732// Use 'Purge' to remove messages marked as deleted
[2d08c50f]733$rcmail_config['flag_for_deletion'] = false;
[2b58528]734
[95d90f8]735// Default interval for keep-alive/check-recent requests (in seconds)
736// Must be greater than or equal to 'min_keep_alive' and less than 'session_lifetime'
737$rcmail_config['keep_alive'] = 60;
738
[2fd9750]739// If true all folders will be checked for recent messages
[2d08c50f]740$rcmail_config['check_all_folders'] = false;
[2fd9750]741
[e54bb72]742// If true, after message delete/move, the next message will be displayed
[2d08c50f]743$rcmail_config['display_next'] = false;
[e54bb72]744
[f52c936f]745// 0 - Do not expand threads
746// 1 - Expand all threads automatically
747// 2 - Expand only threads with unread messages
748$rcmail_config['autoexpand_threads'] = 0;
[1cead0c]749
[50f56d2]750// When replying place cursor above original message (top posting)
[2d08c50f]751$rcmail_config['top_posting'] = false;
[50f56d2]752
[0207c45]753// When replying strip original signature from message
[2d08c50f]754$rcmail_config['strip_existing_sig'] = true;
[0207c45]755
[50f56d2]756// Show signature:
[0207c45]757// 0 - Never
758// 1 - Always
[50f56d2]759// 2 - New messages only
[0207c45]760// 3 - Forwards and Replies only
761$rcmail_config['show_sig'] = 1;
762
763// When replying or forwarding place sender's signature above existing message
[2d08c50f]764$rcmail_config['sig_above'] = false;
[50f56d2]765
[47ad83f]766// Use MIME encoding (quoted-printable) for 8bit characters in message body
[2d08c50f]767$rcmail_config['force_7bit'] = false;
[47ad83f]768
[b975da2]769// Defaults of the search field configuration.
770// The array can contain a per-folder list of header fields which should be considered when searching
771// The entry with key '*' stands for all folders which do not have a specific list set.
772// Please note that folder names should to be in sync with $rcmail_config['default_imap_folders']
773$rcmail_config['search_mods'] = null;  // Example: array('*' => array('subject'=>1, 'from'=>1), 'Sent' => array('subject'=>1, 'to'=>1));
774
[3cacf94]775// Defaults of the addressbook search field configuration.
776$rcmail_config['addressbook_search_mods'] = null;  // Example: array('name'=>1, 'firstname'=>1, 'surname'=>1, 'email'=>1, '*'=>1);
777
[b7f9522]778// 'Delete always'
779// This setting reflects if mail should be always deleted
780// when moving to Trash fails. This is necessary in some setups
781// when user is over quota and Trash is included in the quota.
782$rcmail_config['delete_always'] = false;
783
[f22ea7b]784// Behavior if a received message requests a message delivery notification (read receipt)
785// 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask)
786// 3 = send automatically if sender is in addressbook, otherwise ask the user
787// 4 = send automatically if sender is in addressbook, otherwise ignore
788$rcmail_config['mdn_requests'] = 0;
[b25dfd0]789
[f22ea7b]790// Return receipt checkbox default state
791$rcmail_config['mdn_default'] = 0;
792
793// Delivery Status Notification checkbox default state
794$rcmail_config['dsn_default'] = 0;
795
[eeb85f4]796// Place replies in the folder of the message being replied to
797$rcmail_config['reply_same_folder'] = false;
798
[a509bb6]799// Sets default mode of Forward feature to "forward as attachment"
800$rcmail_config['forward_attachment'] = false;
801
[d7344819]802// Defines address book (internal index) to which new contacts will be added
803// By default it is the first writeable addressbook.
804// Note: Use '0' for built-in address book.
805$rcmail_config['default_addressbook'] = null;
806
[1d5779b]807// Enables spell checking before sending a message.
808$rcmail_config['spellcheck_before_send'] = false;
809
[710b1bd]810// Skip alternative email addresses in autocompletion (show one address per contact)
811$rcmail_config['autocomplete_single'] = false;
812
[7e263ea2]813// Default font for composed HTML message.
814// Supported values: Andale Mono, Arial, Arial Black, Book Antiqua, Courier New,
815// Georgia, Helvetica, Impact, Tahoma, Terminal, Times New Roman, Trebuchet MS, Verdana
816$rcmail_config['default_font'] = '';
817
[f22ea7b]818// end of config file
Note: See TracBrowser for help on using the repository browser.