load_defaults(); // register these boolean fields $RCI->bool_config_props = array( 'ip_check' => 1, 'enable_caching' => 1, 'enable_spellcheck' => 1, 'auto_create_user' => 1, 'smtp_log' => 1, 'prefer_html' => 1, 'preview_pane' => 1, 'htmleditor' => 1, 'debug_level' => 1, ); // allow the current user to get to the next step $_SESSION['allowinstaller'] = true; if (!empty($_POST['submit'])) { echo '

Copy or download the following configurations and save them in two files'; echo ' (names above the text box) within the '.RCMAIL_CONFIG_DIR.' directory of your Roundcube installation.
'; echo ' Make sure that there are no characters outside the <?php ?> brackets when saving the files.

'; $textbox = new html_textarea(array('rows' => 16, 'cols' => 60, 'class' => "configfile")); echo '
main.inc.php (download)
'; echo $textbox->show(($_SESSION['main.inc.php'] = $RCI->create_config('main'))); echo '
db.inc.php (download)
'; echo $textbox->show($_SESSION['db.inc.php'] = $RCI->create_config('db')); echo '

Of course there are more options to configure. Have a look at the config files or visit Howto_Config to find out.

'; echo '

'; // echo ''; echo "\n
\n"; } ?>
General configuration
product_name
'_product_name', 'size' => 30, 'id' => "cfgprodname")); echo $input_prodname->show($RCI->getprop('product_name')); ?>
The name of your service (used to compose page titles)
temp_dir
'_temp_dir', 'size' => 30, 'id' => "cfgtempdir")); echo $input_tempdir->show($RCI->getprop('temp_dir')); ?>
Use this folder to store temp files (must be writeable for webserver)
ip_check
'_ip_check', 'id' => "cfgipcheck")); echo $check_ipcheck->show(intval($RCI->getprop('ip_check')), array('value' => 1)); ?>

This increases security but can cause sudden logouts when someone uses a proxy with changeing IPs.

des_key
'_des_key', 'size' => 30, 'id' => "cfgdeskey")); echo $input_deskey->show($RCI->getprop('des_key')); ?>
This key is used to encrypt the users imap password before storing in the session record

It's a random generated string to ensure that every installation has it's own key. If you enter it manually please provide a string of exactly 24 chars.

enable_caching
'_enable_caching', 'id' => "cfgcache")); echo $check_caching->show(intval($RCI->getprop('enable_caching')), array('value' => 1)); ?>
enable_spellcheck
'_enable_spellcheck', 'id' => "cfgspellcheck")); echo $check_spell->show(intval($RCI->getprop('enable_spellcheck')), array('value' => 1)); ?>
spellcheck_engine
'_spellcheck_engine', 'id' => "cfgspellcheckengine")); if (extension_loaded('pspell')) $select_spell->add('pspell', 'pspell'); $select_spell->add('Googie', 'googie'); echo $select_spell->show($RCI->is_post ? $_POST['_spellcheck_engine'] : 'pspell'); ?>

GoogieSpell implies that the message content will be sent to Google in order to check the spelling.

identities_level
'_identities_level', 'id' => "cfgidentitieslevel")); $input_ilevel->add('many identities with possibility to edit all params', 0); $input_ilevel->add('many identities with possibility to edit all params but not email address', 1); $input_ilevel->add('one identity with possibility to edit all params', 2); $input_ilevel->add('one identity with possibility to edit all params but not email address', 3); echo $input_ilevel->show($RCI->getprop('identities_level'), 0); ?>
Level of identities access

Defines what users can do with their identities.

Logging & Debugging
debug_level
getprop('debug_level'); $check_debug = new html_checkbox(array('name' => '_debug_level[]')); echo $check_debug->show(($value & 1) ? 1 : 0 , array('value' => 1, 'id' => 'cfgdebug1')); echo '
'; echo $check_debug->show(($value & 4) ? 4 : 0, array('value' => 4, 'id' => 'cfgdebug4')); echo '
'; echo $check_debug->show(($value & 8) ? 8 : 0, array('value' => 8, 'id' => 'cfgdebug8')); echo '
'; ?>
log_driver
'_log_driver', 'id' => "cfglogdriver")); $select_log_driver->add(array('file', 'syslog'), array('file', 'syslog')); echo $select_log_driver->show($RCI->getprop('log_driver', 'file')); ?>
How to do logging? 'file' - write to files in the log directory, 'syslog' - use the syslog facility.
log_dir
'_log_dir', 'size' => 30, 'id' => "cfglogdir")); echo $input_logdir->show($RCI->getprop('log_dir')); ?>
Use this folder to store log files (must be writeable for webserver). Note that this only applies if you are using the 'file' log_driver.
syslog_id
'_syslog_id', 'size' => 30, 'id' => "cfgsyslogid")); echo $input_syslogid->show($RCI->getprop('syslog_id', 'roundcube')); ?>
What ID to use when logging with syslog. Note that this only applies if you are using the 'syslog' log_driver.
syslog_facility
'_syslog_facility', 'id' => "cfgsyslogfacility")); $input_syslogfacility->add('user-level messages', LOG_USER); $input_syslogfacility->add('mail subsystem', LOG_MAIL); $input_syslogfacility->add('local level 0', LOG_LOCAL0); $input_syslogfacility->add('local level 1', LOG_LOCAL1); $input_syslogfacility->add('local level 2', LOG_LOCAL2); $input_syslogfacility->add('local level 3', LOG_LOCAL3); $input_syslogfacility->add('local level 4', LOG_LOCAL4); $input_syslogfacility->add('local level 5', LOG_LOCAL5); $input_syslogfacility->add('local level 6', LOG_LOCAL6); $input_syslogfacility->add('local level 7', LOG_LOCAL7); echo $input_syslogfacility->show($RCI->getprop('syslog_facility'), LOG_USER); ?>
What ID to use when logging with syslog. Note that this only applies if you are using the 'syslog' log_driver.
Database setup
db_dsnw

Database settings for read/write operations:

'mysql', 'MySQLi' => 'mysqli', 'PgSQL' => 'pgsql', 'SQLite' => 'sqlite'); $select_dbtype = new html_select(array('name' => '_dbtype', 'id' => "cfgdbtype")); foreach ($supported_dbs AS $database => $ext) { if (extension_loaded($ext)) { $select_dbtype->add($database, $ext); } } $input_dbhost = new html_inputfield(array('name' => '_dbhost', 'size' => 20, 'id' => "cfgdbhost")); $input_dbname = new html_inputfield(array('name' => '_dbname', 'size' => 20, 'id' => "cfgdbname")); $input_dbuser = new html_inputfield(array('name' => '_dbuser', 'size' => 20, 'id' => "cfgdbuser")); $input_dbpass = new html_passwordfield(array('name' => '_dbpass', 'size' => 20, 'id' => "cfgdbpass")); $dsnw = MDB2::parseDSN($RCI->getprop('db_dsnw')); echo $select_dbtype->show($RCI->is_post ? $_POST['_dbtype'] : $dsnw['phptype']); echo '
'; echo $input_dbhost->show($RCI->is_post ? $_POST['_dbhost'] : $dsnw['hostspec']); echo '
'; echo $input_dbname->show($RCI->is_post ? $_POST['_dbname'] : $dsnw['database']); echo '
'; echo $input_dbuser->show($RCI->is_post ? $_POST['_dbuser'] : $dsnw['username']); echo '
'; echo $input_dbpass->show($RCI->is_post ? $_POST['_dbpass'] : $dsnw['password']); echo '
'; ?>
IMAP Settings
default_host
The IMAP host(s) chosen to perform the log-in
'_default_host[]', 'size' => 30)); $default_hosts = $RCI->get_hostlist(); if (empty($default_hosts)) $default_hosts = array(''); $i = 0; foreach ($default_hosts as $host) { echo '
' . $text_imaphost->show($host); if ($i++ > 0) echo 'remove'; echo '
'; } ?>
add

Leave blank to show a textbox at login. To use SSL/IMAPS connection, type ssl://hostname

default_port
'_default_port', 'size' => 6, 'id' => "cfgimapport")); echo $text_imapport->show($RCI->getprop('default_port')); ?>
TCP port used for IMAP connections
username_domain
'_username_domain', 'size' => 30, 'id' => "cfguserdomain")); echo $text_userdomain->show($RCI->getprop('username_domain')); ?>
Automatically add this domain to user names for login

Only for IMAP servers that require full e-mail addresses for login

auto_create_user
'_auto_create_user', 'id' => "cfgautocreate")); echo $check_autocreate->show(intval($RCI->getprop('auto_create_user')), array('value' => 1)); ?>

A user is authenticated by the IMAP server but it requires a local record to store settings and contacts. With this option enabled a new user record will automatically be created once the IMAP login succeeds.

If this option is disabled, the login only succeeds if there's a matching user-record in the local Roundcube database what means that you have to create those records manually or disable this option after the first login.

sent_mbox
'_sent_mbox', 'size' => 20, 'id' => "cfgsentmbox")); echo $text_sentmbox->show($RCI->getprop('sent_mbox')); ?>
Store sent messages in this folder

Leave blank if sent messages should not be stored

trash_mbox
'_trash_mbox', 'size' => 20, 'id' => "cfgtrashmbox")); echo $text_trashmbox->show($RCI->getprop('trash_mbox')); ?>
Move messages to this folder when deleting them

Leave blank if they should be deleted directly

drafts_mbox
'_drafts_mbox', 'size' => 20, 'id' => "cfgdraftsmbox")); echo $text_draftsmbox->show($RCI->getprop('drafts_mbox')); ?>
Store draft messages in this folder

Leave blank if they should not be stored

junk_mbox
'_junk_mbox', 'size' => 20, 'id' => "cfgjunkmbox")); echo $text_junkmbox->show($RCI->getprop('junk_mbox')); ?>
Store spam messages in this folder
SMTP Settings
smtp_server
'_smtp_server', 'size' => 30, 'id' => "cfgsmtphost")); echo $text_smtphost->show($RCI->getprop('smtp_server')); ?>
Use this host for sending mails

To use SSL connection, set ssl://smtp.host.com. If left blank, the PHP mail() function is used

smtp_port
'_smtp_port', 'size' => 6, 'id' => "cfgsmtpport")); echo $text_smtpport->show($RCI->getprop('smtp_port')); ?>
SMTP port (default is 25; 465 for SSL; 587 for submission)
smtp_user/smtp_pass
'_smtp_user', 'size' => 20, 'id' => "cfgsmtpuser")); $text_smtppass = new html_passwordfield(array('name' => '_smtp_pass', 'size' => 20, 'id' => "cfgsmtppass")); echo $text_smtpuser->show($RCI->getprop('smtp_user')); echo $text_smtppass->show($RCI->getprop('smtp_pass')); ?>
SMTP username and password (if required)

'_smtp_user_u', 'id' => "cfgsmtpuseru")); echo $check_smtpuser->show($RCI->getprop('smtp_user') == '%u' || $_POST['_smtp_user_u'] ? 1 : 0, array('value' => 1)); ?>

smtp_log
'_smtp_log', 'id' => "cfgsmtplog")); echo $check_smtplog->show(intval($RCI->getprop('smtp_log')), array('value' => 1)); ?>
Display settings & user prefs
language *
'_language', 'size' => 6, 'id' => "cfglocale")); echo $input_locale->show($RCI->getprop('language')); ?>
The default locale setting. This also defines the language of the login screen.
Leave it empty to auto-detect the user agent language.

Enter a RFC1766 formatted language name. Examples: en_US, de_DE, de_CH, fr_FR, pt_BR

skin *
'_skin', 'size' => 30, 'id' => "cfgskin")); echo $input_skin->show($RCI->getprop('skin')); ?>
Name of interface skin (folder in /skins)
pagesize *
'_pagesize', 'size' => 6, 'id' => "cfgpagesize")); echo $input_pagesize->show($RCI->getprop('pagesize')); ?>
Show up to X items in list view.
prefer_html *
'_prefer_html', 'id' => "cfghtmlview", 'value' => 1)); echo $check_htmlview->show(intval($RCI->getprop('prefer_html'))); ?>
preview_pane *
'_preview_pane', 'id' => "cfgprevpane", 'value' => 1)); echo $check_prevpane->show(intval($RCI->getprop('preview_pane'))); ?>
htmleditor *
'_htmleditor', 'id' => "cfghtmlcompose", 'value' => 1)); echo $check_htmlcomp->show(intval($RCI->getprop('htmleditor'))); ?>
draft_autosave *
'_draft_autosave', 'id' => 'cfgautosave')); $select_autosave->add('never', 0); foreach (array(1, 3, 5, 10) as $i => $min) $select_autosave->add("$min min", $min*60); echo $select_autosave->show(intval($RCI->getprop('draft_autosave'))); ?>
mdn_requests *
'ask the user', 1 => 'send automatically', 3 => 'send receipt to user contacts only', 2 => 'ignore', ); $select_mdnreq = new html_select(array('name' => '_mdn_requests', 'id' => "cfgmdnreq")); $select_mdnreq->add(array_values($mdn_opts), array_keys($mdn_opts)); echo $select_mdnreq->show(intval($RCI->getprop('mdn_requests'))); ?>
Behavior if a received message requests a message delivery notification (read receipt)
mime_param_folding *
'_mime_param_folding', 'id' => "cfgmimeparamfolding")); $select_param_folding->add('Full RFC 2231 (Roundcube, Thunderbird)', '0'); $select_param_folding->add('RFC 2047/2231 (MS Outlook, OE)', '1'); $select_param_folding->add('Full RFC 2047 (deprecated)', '2'); echo $select_param_folding->show(intval($RCI->getprop('mime_param_folding'))); ?>
How to encode attachment long/non-ascii names

*  These settings are defaults for the user preferences

failures ? 'disabled' : '') . ' />

'; ?>