4 +-----------------------------------------------------------------------+
5 | Main configuration file |
7 | This file is part of the Roundcube Webmail client |
8 | Copyright (C) 2005-2011, The Roundcube Dev Team |
9 | Licensed under the GNU GPL |
11 +-----------------------------------------------------------------------+
15 $http_host=$_SERVER['HTTP_HOST'];
16 if (substr($http_host, 0, strlen("roundcube.")) == "roundcube.") {
17 $http_host = substr($http_host, strlen("roundcube."));
20 $rcmail_config = array();
22 // ----------------------------------
24 // ----------------------------------
26 // system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace
27 $rcmail_config['debug_level'] = 1;
29 // log driver: 'syslog' or 'file'.
30 $rcmail_config['log_driver'] = 'file';
32 // date format for log entries
33 // (read http://php.net/manual/en/function.date.php for all format characters)
34 $rcmail_config['log_date_format'] = 'd-M-Y H:i:s O';
36 // Syslog ident string to use, if using the 'syslog' log driver.
37 $rcmail_config['syslog_id'] = 'roundcube';
39 // Syslog facility to use, if using the 'syslog' log driver.
40 // For possible values see installer or http://php.net/manual/en/function.openlog.php
41 $rcmail_config['syslog_facility'] = LOG_MAIL
;
43 // Log sent messages to <log_dir>/sendmail or to syslog
44 $rcmail_config['smtp_log'] = true;
46 // Log successful logins to <log_dir>/userlogins or to syslog
47 $rcmail_config['log_logins'] = false;
49 // Log session authentication errors to <log_dir>/session or to syslog
50 $rcmail_config['log_session'] = false;
52 // Log SQL queries to <log_dir>/sql or to syslog
53 $rcmail_config['sql_debug'] = false;
55 // Log IMAP conversation to <log_dir>/imap or to syslog
56 $rcmail_config['imap_debug'] = false;
58 // Log LDAP conversation to <log_dir>/ldap or to syslog
59 $rcmail_config['ldap_debug'] = false;
61 // Log SMTP conversation to <log_dir>/smtp or to syslog
62 $rcmail_config['smtp_debug'] = false;
64 // ----------------------------------
66 // ----------------------------------
68 // the mail host chosen to perform the log-in
69 // leave blank to show a textbox at login, give a list of hosts
70 // to display a pulldown menu or set one host as string.
71 // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
72 // Supported replacement variables:
73 // %n - http hostname ($_SERVER['SERVER_NAME'])
74 // %d - domain (http hostname without the first part)
75 // %s - domain name after the '@' from e-mail address provided at login screen
76 // For example %n = mail.domain.tld, %d = domain.tld
77 $rcmail_config['default_host'] = 'localhost';
79 // TCP port used for IMAP connections
80 $rcmail_config['default_port'] = 143;
82 // IMAP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
83 // best server supported one)
84 $rcmail_config['imap_auth_type'] = null;
86 // If you know your imap's folder delimiter, you can specify it here.
87 // Otherwise it will be determined automatically
88 $rcmail_config['imap_delimiter'] = null;
90 // If IMAP server doesn't support NAMESPACE extension, but you're
91 // using shared folders or personal root folder is non-empty, you'll need to
92 // set these options. All can be strings or arrays of strings.
93 // Folders need to be ended with directory separator, e.g. "INBOX."
94 // (special directory "~" is an exception to this rule)
95 // These can be used also to overwrite server's namespaces
96 $rcmail_config['imap_ns_personal'] = null;
97 $rcmail_config['imap_ns_other'] = null;
98 $rcmail_config['imap_ns_shared'] = null;
100 // By default IMAP capabilities are readed after connection to IMAP server
101 // In some cases, e.g. when using IMAP proxy, there's a need to refresh the list
102 // after login. Set to True if you've got this case.
103 $rcmail_config['imap_force_caps'] = false;
105 // By default list of subscribed folders is determined using LIST-EXTENDED
106 // extension if available. Some servers (dovecot 1.x) returns wrong results
107 // for shared namespaces in this case. http://trac.roundcube.net/ticket/1486225
108 // Enable this option to force LSUB command usage instead.
109 $rcmail_config['imap_force_lsub'] = false;
111 // IMAP connection timeout, in seconds. Default: 0 (no limit)
112 $rcmail_config['imap_timeout'] = 0;
114 // Optional IMAP authentication identifier to be used as authorization proxy
115 $rcmail_config['imap_auth_cid'] = null;
117 // Optional IMAP authentication password to be used for imap_auth_cid
118 $rcmail_config['imap_auth_pw'] = null;
120 // Type of IMAP indexes cache. Supported values: 'db', 'apc' and 'memcache'.
121 $rcmail_config['imap_cache'] = null;
123 // Enables messages cache. Only 'db' cache is supported.
124 $rcmail_config['messages_cache'] = false;
127 // ----------------------------------
129 // ----------------------------------
131 // SMTP server host (for sending mails).
132 // To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
133 // If left blank, the PHP mail() function is used
134 // Supported replacement variables:
135 // %h - user's IMAP hostname
136 // %n - http hostname ($_SERVER['SERVER_NAME'])
137 // %d - domain (http hostname without the first part)
138 // %z - IMAP domain (IMAP hostname without the first part)
139 // For example %n = mail.domain.tld, %d = domain.tld
140 $rcmail_config['smtp_server'] = '';
142 // SMTP port (default is 25; 465 for SSL)
143 $rcmail_config['smtp_port'] = 465;
145 // SMTP username (if required) if you use %u as the username Roundcube
146 // will use the current username for login
147 $rcmail_config['smtp_user'] = '';
149 // SMTP password (if required) if you use %p as the password Roundcube
150 // will use the current user's password for login
151 $rcmail_config['smtp_pass'] = '';
153 // SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
154 // best server supported one)
155 $rcmail_config['smtp_auth_type'] = '';
157 // Optional SMTP authentication identifier to be used as authorization proxy
158 $rcmail_config['smtp_auth_cid'] = null;
160 // Optional SMTP authentication password to be used for smtp_auth_cid
161 $rcmail_config['smtp_auth_pw'] = null;
164 // Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages
165 // Leave this blank and you will get the server variable 'server_name' or
166 // localhost if that isn't defined.
167 $rcmail_config['smtp_helo_host'] = '';
169 // SMTP connection timeout, in seconds. Default: 0 (no limit)
170 $rcmail_config['smtp_timeout'] = 0;
172 // ----------------------------------
174 // ----------------------------------
176 // THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA.
177 // ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING!
178 $rcmail_config['enable_installer'] = false;
180 // use this folder to store log files (must be writeable for apache user)
181 // This is used by the 'file' log driver.
182 $rcmail_config['log_dir'] = '/home/www/log/php5/fpm/roundcube/';
184 // use this folder to store temp files (must be writeable for apache user)
185 $rcmail_config['temp_dir'] = 'temp/';
187 // lifetime of message cache
188 // possible units: s, m, h, d, w
189 $rcmail_config['message_cache_lifetime'] = '10d';
191 // enforce connections over https
192 // with this option enabled, all non-secure connections will be redirected.
193 // set the port for the ssl connection as value of this option if it differs from the default 443
194 $rcmail_config['force_https'] = true;
196 // tell PHP that it should work as under secure connection
197 // even if it doesn't recognize it as secure ($_SERVER['HTTPS'] is not set)
198 // e.g. when you're running Roundcube behind a https proxy
199 $rcmail_config['use_https'] = true;
201 // Allow browser-autocompletion on login form.
202 // 0 - disabled, 1 - username and host only, 2 - username, host, password
203 $rcmail_config['login_autocomplete'] = 2;
205 // If users authentication is not case sensitive this must be enabled.
206 // You can also use it to force conversion of logins to lower case.
207 // After enabling it all user records need to be updated, e.g. with query:
208 // UPDATE users SET username = LOWER(username);
209 $rcmail_config['login_lc'] = false;
211 // automatically create a new Roundcube user when log-in the first time.
212 // a new user will be created once the IMAP login succeeds.
213 // set to false if only registered users can use this service
214 $rcmail_config['auto_create_user'] = true;
216 // replace Roundcube logo with this image
217 // specify an URL relative to the document root of this Roundcube installation
218 if (file_exists("/home/www/data/roundcube/images/logo-$http_host.png")) {
219 $rcmail_config['skin_logo'] = "./images/logo-$http_host.png";
222 $rcmail_config['skin_logo'] = null;
225 // Includes should be interpreted as PHP files
226 $rcmail_config['skin_include_php'] = false;
228 // Session lifetime in minutes
229 // must be greater than 'keep_alive'/60
230 $rcmail_config['session_lifetime'] = 10;
232 // session domain: .example.org
233 $rcmail_config['session_domain'] = '';
235 // session name. Default: 'roundcube_sessid'
236 $rcmail_config['session_name'] = null;
238 // Backend to use for session storage. Can either be 'db' (default) or 'memcache'
239 // If set to memcache, a list of servers need to be specified in 'memcache_hosts'
240 // Make sure the Memcache extension (http://pecl.php.net/package/memcache) version >= 2.0.0 is installed
241 $rcmail_config['session_storage'] = 'db';
243 // Use these hosts for accessing memcached
244 // Define any number of hosts in the form hostname:port
245 $rcmail_config['memcache_hosts'] = null; // e.g. array( 'localhost:11211', '192.168.1.12:11211' );
247 // check client IP in session authorization
248 $rcmail_config['ip_check'] = false;
250 // check referer of incoming requests
251 $rcmail_config['referer_check'] = false;
253 // X-Frame-Options HTTP header value sent to prevent from Clickjacking.
254 // Possible values: sameorigin|deny. Set to false in order to disable sending them
255 $rcmail_config['x_frame_options'] = 'sameorigin';
257 // this key is used to encrypt the users imap password which is stored
258 // in the session record (and the client cookie if remember password is enabled).
259 // please provide a string of exactly 24 chars.
260 // $rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str';
261 include_once("/etc/roundcube/key.inc.php");
263 // Automatically add this domain to user names for login
264 // Only for IMAP servers that require full e-mail addresses for login
265 // Specify an array with 'host' => 'domain' values to support multiple hosts
266 // Supported replacement variables:
267 // %h - user's IMAP hostname
268 // %n - http hostname ($_SERVER['SERVER_NAME'])
269 // %d - domain (http hostname without the first part)
270 // %z - IMAP domain (IMAP hostname without the first part)
271 // For example %n = mail.domain.tld, %d = domain.tld
272 $rcmail_config['username_domain'] = "$http_host";
274 // This domain will be used to form e-mail addresses of new users
275 // Specify an array with 'host' => 'domain' values to support multiple hosts
276 // Supported replacement variables:
277 // %h - user's IMAP hostname
278 // %n - http hostname ($_SERVER['SERVER_NAME'])
279 // %d - domain (http hostname without the first part)
280 // %z - IMAP domain (IMAP hostname without the first part)
281 // For example %n = mail.domain.tld, %d = domain.tld
282 $rcmail_config['mail_domain'] = "$http_host";
285 // Use it if your authentication backend doesn't support UTF-8.
286 // Defaults to ISO-8859-1 for backward compatibility
287 $rcmail_config['password_charset'] = 'UTF-8';
289 // How many seconds must pass between emails sent by a user
290 $rcmail_config['sendmail_delay'] = 10;
292 // Maximum number of recipients per message. Default: 0 (no limit)
293 $rcmail_config['max_recipients'] = 100;
295 // Maximum allowednumber of members of an address group. Default: 0 (no limit)
296 // If 'max_recipients' is set this value should be less or equal
297 $rcmail_config['max_group_members'] = 0;
299 // add this user-agent to message headers when sending
300 $rcmail_config['useragent'] = 'Roundcube Webmail/'.RCMAIL_VERSION
;
302 // use this name to compose page titles
303 $rcmail_config['product_name'] = 'Roundcube Webmail';
305 // try to load host-specific configuration
306 // see http://trac.roundcube.net/wiki/Howto_Config for more details
307 $rcmail_config['include_host_config'] = false;
309 // path to a text file which will be added to each sent message
310 // paths are relative to the Roundcube root folder
311 $rcmail_config['generic_message_footer'] = '';
313 // path to a text file which will be added to each sent HTML message
314 // paths are relative to the Roundcube root folder
315 $rcmail_config['generic_message_footer_html'] = '';
317 // add a received header to outgoing mails containing the creators IP and hostname
318 $rcmail_config['http_received_header'] = false;
320 // Whether or not to encrypt the IP address and the host name
321 // these could, in some circles, be considered as sensitive information;
322 // however, for the administrator, these could be invaluable help
323 // when tracking down issues.
324 $rcmail_config['http_received_header_encrypt'] = false;
326 // This string is used as a delimiter for message headers when sending
327 // a message via mail() function. Leave empty for auto-detection
328 $rcmail_config['mail_header_delimiter'] = NULL;
330 // number of chars allowed for line when wrapping text.
331 // text wrapping is done when composing/sending messages
332 $rcmail_config['line_length'] = 72;
334 // send plaintext messages as format=flowed
335 $rcmail_config['send_format_flowed'] = true;
337 // don't allow these settings to be overriden by the user
338 $rcmail_config['dont_override'] = array();
340 // Set identities access level:
341 // 0 - many identities with possibility to edit all params
342 // 1 - many identities with possibility to edit all params but not email address
343 // 2 - one identity with possibility to edit all params
344 // 3 - one identity with possibility to edit all params but not email address
345 $rcmail_config['identities_level'] = 0;
347 // Mimetypes supported by the browser.
348 // attachments of these types will open in a preview window
349 // either a comma-separated list or an array: 'text/plain,text/html,text/xml,image/jpeg,image/gif,image/png,application/pdf'
350 $rcmail_config['client_mimetypes'] = null; # null == default
352 // mime magic database
353 $rcmail_config['mime_magic'] = '/usr/share/misc/magic';
355 // path to imagemagick identify binary
356 $rcmail_config['im_identify_path'] = null;
358 // path to imagemagick convert binary
359 $rcmail_config['im_convert_path'] = null;
361 // maximum size of uploaded contact photos in pixel
362 $rcmail_config['contact_photo_size'] = 160;
364 // Enable DNS checking for e-mail address validation
365 $rcmail_config['email_dns_check'] = false;
367 // ----------------------------------
369 // ----------------------------------
371 // List of active plugins (in plugins/ directory)
372 $rcmail_config['plugins'] = array(
375 'recipient_to_contact',
385 #'all_folder_search',
386 'show_additional_headers',
387 #'subscriptions_option',
389 'threading_as_default',
390 'thunderbird_labels',
393 // ----------------------------------
395 // ----------------------------------
397 // Default look of access rights table
398 // In advanced mode all access rights are displayed separately
399 // In simple mode access rights are grouped into four groups: read, write, delete, full
400 $rcmail_config['acl_advanced_mode'] = false;
402 // LDAP addressbook that would be searched for user names autocomplete.
403 // That should be an array refering to the $rcmail_config['ldap_public'] array key
404 // or complete addressbook configuration array.
405 $rcmail_config['acl_users_source'] = '';
407 // The LDAP attribute which will be used as ACL user identifier
408 $rcmail_config['acl_users_field'] = 'mail';
410 // The LDAP search filter will be &'d with search queries
411 $rcmail_config['acl_users_filter'] = '';
413 // ----------------------------------
415 // ----------------------------------
417 // Password Plugin options
418 // -----------------------
419 // A driver to use for password change. Default: "sql".
420 // See README file for list of supported driver names.
421 $rcmail_config['password_driver'] = 'chpasswd';
423 // Determine whether current password is required to change password.
425 $rcmail_config['password_confirm_current'] = true;
427 // Require the new password to be a certain length.
428 // set to blank to allow passwords of any length
429 $rcmail_config['password_minimum_length'] = 12;
431 // Require the new password to contain a letter and punctuation character
432 // Change to false to remove this check.
433 $rcmail_config['password_require_nonalpha'] = true;
435 // Enables logging of password changes into logs/password
436 $rcmail_config['password_log'] = true;
438 // Comma-separated list of login exceptions for which password change
439 // will be not available (no Password tab in Settings)
440 $rcmail_config['password_login_exceptions'] = null;
442 // Array of hosts that support password changing. Default is NULL.
443 // Listed hosts will feature a Password option in Settings; others will not.
445 //$rcmail_config['password_hosts'] = array('mail.example.com', 'mail2.example.org');
446 $rcmail_config['password_hosts'] = null;
448 // chpasswd Driver options
449 // ---------------------
451 $rcmail_config['password_chpasswd_cmd'] = '/usr/local/bin/roundcube-chpasswd';
453 // ----------------------------------
454 // plugin recipient_to_contact
455 // ----------------------------------
458 * Defines which address books are used for searching and adding new contacts to.
460 * Empty array means the plugins uses 'autocomplete_addressbooks' setting from main.inc.php
462 $rcmail_config['recipient_to_contact_addressbooks'] = array('sql');
465 * Whether the plugin is enabled or disabled for users by default.
467 * If set to true, the plugin is enabled and users can disable it through settings menu.
469 $rcmail_config['recipient_to_contact_enabled_by_default'] = true;
472 * Whether the groups feature is enabled or not.
474 * If set to true, the contact group dropdown is shown in the dialog.
476 $rcmail_config['recipient_to_contact_use_groups'] = true;
478 // ----------------------------------
480 // ----------------------------------
482 // default messages sort column. Use empty value for default server's sorting,
483 // or 'arrival', 'date', 'subject', 'from', 'to', 'size', 'cc'
484 $rcmail_config['message_sort_col'] = '';
486 // default messages sort order
487 $rcmail_config['message_sort_order'] = 'DESC';
489 // These cols are shown in the message list. Available cols are:
490 // subject, from, to, cc, replyto, date, size, status, flag, attachment, 'priority'
491 $rcmail_config['list_cols'] = array('subject', 'status', 'junk_keyword', 'from', 'date', 'size', 'flag', 'attachment');
493 // the default locale setting (leave empty for auto-detection)
494 // RFC1766 formatted language name like en_US, de_DE, de_CH, fr_FR, pt_BR
495 $rcmail_config['language'] = fr_FR
;
497 // use this format for date display (date or strftime format)
498 $rcmail_config['date_format'] = 'Y-m-d';
500 // give this choice of date formats to the user to select from
501 $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');
503 // use this format for time display (date or strftime format)
504 $rcmail_config['time_format'] = 'H:i';
506 // give this choice of time formats to the user to select from
507 $rcmail_config['time_formats'] = array('G:i', 'H:i', 'g:i a', 'h:i A');
509 // use this format for short date display (derived from date_format and time_format)
510 $rcmail_config['date_short'] = 'D H:i';
512 // use this format for detailed date/time formatting (derived from date_format and time_format)
513 $rcmail_config['date_long'] = 'Y-m-d H:i';
515 // store draft message is this mailbox
516 // leave blank if draft messages should not be stored
517 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
518 $rcmail_config['drafts_mbox'] = 'Drafts';
520 // store spam messages in this mailbox
521 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
522 $rcmail_config['junk_mbox'] = 'Junk';
524 // store sent message is this mailbox
525 // leave blank if sent messages should not be stored
526 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
527 $rcmail_config['sent_mbox'] = 'Sent';
529 // move messages to this folder when deleting them
530 // leave blank if they should be deleted directly
531 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
532 $rcmail_config['trash_mbox'] = 'Trash';
534 // display these folders separately in the mailbox list.
535 // these folders will also be displayed with localized names
536 // NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP)
537 $rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash');
539 // automatically create the above listed default folders on first login
540 $rcmail_config['create_default_folders'] = false;
542 // protect the default folders from renames, deletes, and subscription changes
543 $rcmail_config['protect_default_folders'] = true;
545 // if in your system 0 quota means no limit set this option to true
546 $rcmail_config['quota_zero_as_unlimited'] = false;
548 // Make use of the built-in spell checker. It is based on GoogieSpell.
549 // Since Google only accepts connections over https your PHP installatation
550 // requires to be compiled with Open SSL support
551 $rcmail_config['enable_spellcheck'] = true;
553 // Enables spellchecker exceptions dictionary.
554 // Setting it to 'shared' will make the dictionary shared by all users.
555 $rcmail_config['spellcheck_dictionary'] = true;
557 // Set the spell checking engine. 'googie' is the default. 'pspell' is also available,
558 // but requires the Pspell extensions. When using Nox Spell Server, also set 'googie' here.
559 $rcmail_config['spellcheck_engine'] = 'pspell';
561 // For a locally installed Nox Spell Server, please specify the URI to call it.
562 // Get Nox Spell Server from http://orangoo.com/labs/?page_id=72
563 // Leave empty to use the Google spell checking service, what means
564 // that the message content will be sent to Google in order to check spelling
565 $rcmail_config['spellcheck_uri'] = '';
567 // These languages can be selected for spell checking.
568 // Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch');
569 // Leave empty for default set of available language.
570 $rcmail_config['spellcheck_languages'] = array
579 // Makes that words with all letters capitalized will be ignored (e.g. GOOGLE)
580 $rcmail_config['spellcheck_ignore_caps'] = false;
582 // Makes that words with numbers will be ignored (e.g. g00gle)
583 $rcmail_config['spellcheck_ignore_nums'] = false;
585 // Makes that words with symbols will be ignored (e.g. g@@gle)
586 $rcmail_config['spellcheck_ignore_syms'] = false;
588 // Use this char/string to separate recipients when composing a new message
589 $rcmail_config['recipients_separator'] = ',';
591 // don't let users set pagesize to more than this value if set
592 $rcmail_config['max_pagesize'] = 200;
594 // Minimal value of user's 'keep_alive' setting (in seconds)
595 // Must be less than 'session_lifetime'
596 $rcmail_config['min_keep_alive'] = 60;
598 // Enables files upload indicator. Requires APC installed and enabled apc.rfc1867 option.
599 // By default refresh time is set to 1 second. You can set this value to true
600 // or any integer value indicating number of seconds.
601 $rcmail_config['upload_progress'] = true;
603 // Specifies for how many seconds the Undo button will be available
604 // after object delete action. Currently used with supporting address book sources.
605 // Setting it to 0, disables the feature.
606 $rcmail_config['undo_timeout'] = 0;
608 // ----------------------------------
609 // ADDRESSBOOK SETTINGS
610 // ----------------------------------
612 // This indicates which type of address book to use. Possible choises:
613 // 'sql' (default) and 'ldap'.
614 // If set to 'ldap' then it will look at using the first writable LDAP
615 // address book as the primary address book and it will not display the
616 // SQL address book in the 'Address Book' view.
617 $rcmail_config['address_book_type'] = 'sql';
619 // In order to enable public ldap search, configure an array like the Verisign
620 // example further below. if you would like to test, simply uncomment the example.
621 // Array key must contain only safe characters, ie. a-zA-Z0-9_
622 $rcmail_config['ldap_public'] = array();
624 // If you are going to use LDAP for individual address books, you will need to
625 // set 'user_specific' to true and use the variables to generate the appropriate DNs to access it.
627 // The recommended directory structure for LDAP is to store all the address book entries
628 // under the users main entry, e.g.:
633 // mail=contact@contactdomain
635 // So the base_dn would be uid=%fu,ou=people,o=root
636 // The bind_dn would be the same as based_dn or some super user login.
638 * example config for Verisign directory
640 $rcmail_config['ldap_public']['Verisign'] = array(
641 'name' => 'Verisign.com',
642 // Replacement variables supported in host names:
643 // %h - user's IMAP hostname
644 // %n - http hostname ($_SERVER['SERVER_NAME'])
645 // %d - domain (http hostname without the first part)
646 // %z - IMAP domain (IMAP hostname without the first part)
647 // For example %n = mail.domain.tld, %d = domain.tld
648 'hosts' => array('directory.verisign.com'),
651 'ldap_version' => 3, // using LDAPv3
652 'user_specific' => false, // If true the base_dn, bind_dn and bind_pass default to the user's IMAP login.
653 // %fu - The full username provided, assumes the username is an email
654 // address, uses the username_domain value if not an email address.
655 // %u - The username prior to the '@'.
656 // %d - The domain name after the '@'.
657 // %dc - The domain name hierarchal string e.g. "dc=test,dc=domain,dc=com"
658 // %dn - DN found by ldap search when search_filter/search_base_dn are used
662 // It's possible to bind for an individual address book
663 // The login name is used to search for the DN to bind with
664 'search_base_dn' => '',
665 'search_filter' => '', // e.g. '(&(objectClass=posixAccount)(uid=%u))'
666 // DN and password to bind as before searching for bind DN, if anonymous search is not allowed
667 'search_bind_dn' => '',
668 'search_bind_pw' => '',
669 // Default for %dn variable if search doesn't return DN value
670 'search_dn_default' => '',
671 // Optional authentication identifier to be used as SASL authorization proxy
672 // bind_dn need to be empty
674 // SASL authentication method (for proxy auth), e.g. DIGEST-MD5
676 // Indicates if the addressbook shall be hidden from the list.
677 // With this option enabled you can still search/view contacts.
679 // Indicates if the addressbook shall not list contacts but only allows searching.
680 'searchonly' => false,
681 // Indicates if we can write to the LDAP directory or not.
682 // If writable is true then these fields need to be populated:
683 // LDAP_Object_Classes, required_fields, LDAP_rdn
685 // To create a new contact these are the object classes to specify
686 // (or any other classes you wish to use).
687 'LDAP_Object_Classes' => array('top', 'inetOrgPerson'),
688 // The RDN field that is used for new entries, this field needs
689 // to be one of the search_fields, the base of base_dn is appended
690 // to the RDN to insert into the LDAP directory.
691 'LDAP_rdn' => 'mail',
692 // The required fields needed to build a new contact as required by
693 // the object classes (can include additional fields not required by the object classes).
694 'required_fields' => array('cn', 'sn', 'mail'),
695 'search_fields' => array('mail', 'cn'), // fields to search in
696 // mapping of contact fields to directory attributes
701 'firstname' => 'givenName',
703 'phone:home' => 'homePhone',
704 'phone:work' => 'telephoneNumber',
705 'phone:mobile' => 'mobile',
706 'street' => 'street',
707 'zipcode' => 'postalCode',
710 'organization' => 'o',
712 'sort' => 'cn', // The field to sort the listing by.
713 'scope' => 'sub', // search mode: sub|base|list
714 'filter' => '(objectClass=inetOrgPerson)', // used for basic listing (if not empty) and will be &'d with search queries. example: status=act
715 'fuzzy_search' => true, // server allows wildcard search
716 'vlv' => false, // Enable Virtual List View to more efficiently fetch paginated data (if server supports it)
717 '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
718 'sizelimit' => '0', // Enables you to limit the count of entries fetched. Setting this to 0 means no limit.
719 'timelimit' => '0', // Sets the number of seconds how long is spend on the search. Setting this to 0 means no limit.
720 'referrals' => true|false, // Sets the LDAP_OPT_REFERRALS option. Mostly used in multi-domain Active Directory setups
722 // definition for contact groups (uncomment if no groups are supported)
723 // for the groups base_dn, the user replacements %fu, %u, $d and %dc work as for base_dn (see above)
724 // if the groups base_dn is empty, the contact base_dn is used for the groups as well
725 // -> in this case, assure that groups and contacts are separated due to the concernig filters!
728 'scope' => 'sub', // search mode: sub|base|list
729 'filter' => '(objectClass=groupOfNames)',
730 'object_classes' => array("top", "groupOfNames"),
731 'member_attr' => 'member', // name of the member attribute, e.g. uniqueMember
732 'name_attr' => 'cn', // attribute to be used as group name
737 // An ordered array of the ids of the addressbooks that should be searched
738 // when populating address autocomplete fields server-side. ex: array('sql','Verisign');
739 $rcmail_config['autocomplete_addressbooks'] = array('sql');
741 // The minimum number of characters required to be typed in an autocomplete field
742 // before address books will be searched. Most useful for LDAP directories that
743 // may need to do lengthy results building given overly-broad searches
744 $rcmail_config['autocomplete_min_length'] = 1;
746 // Number of parallel autocomplete requests.
747 // If there's more than one address book, n parallel (async) requests will be created,
748 // where each request will search in one address book. By default (0), all address
749 // books are searched in one request.
750 $rcmail_config['autocomplete_threads'] = 0;
752 // Max. numer of entries in autocomplete popup. Default: 15.
753 $rcmail_config['autocomplete_max'] = 15;
755 // show address fields in this order
756 // available placeholders: {street}, {locality}, {zipcode}, {country}, {region}
757 $rcmail_config['address_template'] = '{street}<br/>{locality} {zipcode}<br/>{country} {region}';
759 // Matching mode for addressbook search (including autocompletion)
760 // 0 - partial (*abc*), default
763 // Note: For LDAP sources fuzzy_search must be enabled to use 'partial' or 'prefix' mode
764 $rcmail_config['addressbook_search_mode'] = 0;
766 // ----------------------------------
768 // ----------------------------------
770 // Use this charset as fallback for message decoding
771 $rcmail_config['default_charset'] = 'UTF-8';
773 // skin name: folder from skins/
774 $rcmail_config['skin'] = 'default';
776 // show up to X items in list view
777 $rcmail_config['pagesize'] = 40;
779 // sort contacts by this col (preferably either one of name, firstname, surname)
780 $rcmail_config['addressbook_sort_col'] = 'surname';
782 // the way how contact names are displayed in the list
784 // 1: (prefix) firstname middlename surname (suffix)
785 // 2: (prefix) surname firstname middlename (suffix)
786 // 3: (prefix) surname, firstname middlename (suffix)
787 $rcmail_config['addressbook_name_listing'] = 0;
789 // use this timezone to display date/time
790 $rcmail_config['timezone'] = 'auto';
792 // is daylight saving On? Default: (bool)date('I');
793 $rcmail_config['dst_active'] = null;
795 // prefer displaying HTML messages
796 $rcmail_config['prefer_html'] = false;
798 // display remote inline images
799 // 0 - Never, always ask
800 // 1 - Ask if sender is not in address book
801 // 2 - Always show inline images
802 $rcmail_config['show_images'] = 1;
804 // compose html formatted messages by default
805 // 0 - never, 1 - always, 2 - on reply to HTML message only
806 $rcmail_config['htmleditor'] = 0;
808 // show pretty dates as standard
809 $rcmail_config['prettydate'] = true;
811 // save compose message every 300 seconds (5min)
812 $rcmail_config['draft_autosave'] = 60;
814 // default setting if preview pane is enabled
815 $rcmail_config['preview_pane'] = true;
817 // Mark as read when viewed in preview pane (delay in seconds)
818 // Set to -1 if messages in preview pane should not be marked as read
819 $rcmail_config['preview_pane_mark_read'] = 0;
821 // Clear Trash on logout
822 $rcmail_config['logout_purge'] = false;
824 // Compact INBOX on logout
825 $rcmail_config['logout_expunge'] = true;
827 // Display attached images below the message body
828 $rcmail_config['inline_images'] = true;
830 // Encoding of long/non-ascii attachment names:
831 // 0 - Full RFC 2231 compatible
832 // 1 - RFC 2047 for 'name' and RFC 2231 for 'filename' parameter (Thunderbird's default)
833 // 2 - Full 2047 compatible
834 $rcmail_config['mime_param_folding'] = 1;
836 // Set true if deleted messages should not be displayed
837 // This will make the application run slower
838 $rcmail_config['skip_deleted'] = false;
840 // Set true to Mark deleted messages as read as well as deleted
841 // False means that a message's read status is not affected by marking it as deleted
842 $rcmail_config['read_when_deleted'] = true;
844 // Set to true to never delete messages immediately
845 // Use 'Purge' to remove messages marked as deleted
846 $rcmail_config['flag_for_deletion'] = false;
848 // Default interval for keep-alive/check-recent requests (in seconds)
849 // Must be greater than or equal to 'min_keep_alive' and less than 'session_lifetime'
850 $rcmail_config['keep_alive'] = 60;
852 // If true all folders will be checked for recent messages
853 $rcmail_config['check_all_folders'] = true;
855 // If true, after message delete/move, the next message will be displayed
856 $rcmail_config['display_next'] = false;
858 // 0 - Do not expand threads
859 // 1 - Expand all threads automatically
860 // 2 - Expand only threads with unread messages
861 $rcmail_config['autoexpand_threads'] = 2;
863 // When replying place cursor above original message (top posting)
864 $rcmail_config['top_posting'] = false;
866 // When replying strip original signature from message
867 $rcmail_config['strip_existing_sig'] = true;
872 // 2 - New messages only
873 // 3 - Forwards and Replies only
874 $rcmail_config['show_sig'] = 1;
876 // When replying or forwarding place sender's signature above existing message
877 $rcmail_config['sig_above'] = false;
879 // Use MIME encoding (quoted-printable) for 8bit characters in message body
880 $rcmail_config['force_7bit'] = false;
882 // Defaults of the search field configuration.
883 // The array can contain a per-folder list of header fields which should be considered when searching
884 // The entry with key '*' stands for all folders which do not have a specific list set.
885 // Please note that folder names should to be in sync with $rcmail_config['default_imap_folders']
886 $rcmail_config['search_mods'] = null; // Example: array('*' => array('subject'=>1, 'from'=>1), 'Sent' => array('subject'=>1, 'to'=>1));
888 // Defaults of the addressbook search field configuration.
889 $rcmail_config['addressbook_search_mods'] = null; // Example: array('name'=>1, 'firstname'=>1, 'surname'=>1, 'email'=>1, '*'=>1);
892 // This setting reflects if mail should be always deleted
893 // when moving to Trash fails. This is necessary in some setups
894 // when user is over quota and Trash is included in the quota.
895 $rcmail_config['delete_always'] = true;
897 // Behavior if a received message requests a message delivery notification (read receipt)
898 // 0 = ask the user, 1 = send automatically, 2 = ignore (never send or ask)
899 // 3 = send automatically if sender is in addressbook, otherwise ask the user
900 // 4 = send automatically if sender is in addressbook, otherwise ignore
901 $rcmail_config['mdn_requests'] = 0;
903 // Return receipt checkbox default state
904 $rcmail_config['mdn_default'] = 0;
906 // Delivery Status Notification checkbox default state
907 $rcmail_config['dsn_default'] = 0;
909 // Place replies in the folder of the message being replied to
910 $rcmail_config['reply_same_folder'] = true;
912 // Sets default mode of Forward feature to "forward as attachment"
913 $rcmail_config['forward_attachment'] = false;
915 // Defines address book (internal index) to which new contacts will be added
916 // By default it is the first writeable addressbook.
917 // Note: Use '0' for built-in address book.
918 $rcmail_config['default_addressbook'] = null;
920 // Enables spell checking before sending a message.
921 $rcmail_config['spellcheck_before_send'] = false;
923 // Skip alternative email addresses in autocompletion (show one address per contact)
924 $rcmail_config['autocomplete_single'] = false;
926 // ----------------------------------
927 // plugin manage sieve
928 // ----------------------------------
930 // managesieve server port. When empty the port will be determined automatically
931 // using getservbyname() function, with 4190 as a fallback.
932 $rcmail_config['managesieve_port'] = 4190;
934 // managesieve server address, default is localhost.
935 // Replacement variables supported in host name:
936 // %h - user's IMAP hostname
937 // %n - http hostname ($_SERVER['SERVER_NAME'])
938 // %d - domain (http hostname without the first part)
939 // For example %n = mail.domain.tld, %d = domain.tld
940 $rcmail_config['managesieve_host'] = 'localhost';
942 // authentication method. Can be CRAM-MD5, DIGEST-MD5, PLAIN, LOGIN, EXTERNAL
943 // or none. Optional, defaults to best method supported by server.
944 $rcmail_config['managesieve_auth_type'] = null;
946 // Optional managesieve authentication identifier to be used as authorization proxy.
947 // Authenticate as a different user but act on behalf of the logged in user.
948 // Works with PLAIN and DIGEST-MD5 auth.
949 $rcmail_config['managesieve_auth_cid'] = null;
951 // Optional managesieve authentication password to be used for imap_auth_cid
952 $rcmail_config['managesieve_auth_pw'] = null;
954 // use or not TLS for managesieve server connection
955 // Note: tls:// prefix in managesieve_host is also supported
956 $rcmail_config['managesieve_usetls'] = false;
958 // default contents of filters script (eg. default spam filter)
959 $rcmail_config['managesieve_default'] = '/home/mail/sieve/global.d';
962 // The name of the script which will be used when there's no user script
963 $rcmail_config['managesieve_script_name'] = 'roundcube';
965 // Sieve RFC says that we should use UTF-8 endcoding for mailbox names,
966 // but some implementations does not covert UTF-8 to modified UTF-7.
967 // Defaults to UTF7-IMAP
968 $rcmail_config['managesieve_mbox_encoding'] = 'UTF-8';
970 // I need this because my dovecot (with listescape plugin) uses
971 // ':' delimiter, but creates folders with dot delimiter
972 $rcmail_config['managesieve_replace_delimiter'] = '';
974 // disabled sieve extensions (body, copy, date, editheader, encoded-character,
975 // envelope, environment, ereject, fileinto, ihave, imap4flags, index,
976 // mailbox, mboxmetadata, regex, reject, relational, servermetadata,
977 // spamtest, spamtestplus, subaddress, vacation, variables, virustest, etc.
978 // Note: not all extensions are implemented
979 $rcmail_config['managesieve_disabled_extensions'] = array();
981 // Enables debugging of conversation with sieve server. Logs it into <log_dir>/sieve
982 $rcmail_config['managesieve_debug'] = false;
984 // Enables features described in http://wiki.kolab.org/KEP:14
985 $rcmail_config['managesieve_kolab_master'] = false;
987 // Script name extension used for scripts including. Dovecot uses '.sieve',
988 // Cyrus uses '.siv'. Doesn't matter if you have managesieve_kolab_master disabled.
989 $rcmail_config['managesieve_filename_extension'] = '.sieve';
991 // List of reserved script names (without extension).
992 // Scripts listed here will be not presented to the user.
993 $rcmail_config['managesieve_filename_exceptions'] = array();
995 // end of config file