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)

support_url

'_support_url', 'size' => 50, 'id' => 'cfgsupporturl']); echo $input_support->show($RCI->getprop('support_url')); ?>

Provide a URL where a user can get support for this Roundcube installation.
PLEASE DO NOT LINK TO THE ROUNDCUBE.NET WEBSITE HERE!

Enter an absolute URL (including http://) to a support page/form or a mailto: link.

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)

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 its own key.

ip_check

'_ip_check', 'id' => 'cfgipcheck']); echo $check_ipcheck->show(intval($RCI->getprop('ip_check')), array('value' => 1)); ?> Check client IP in session authorization

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

enable_spellcheck

'_enable_spellcheck', 'id' => 'cfgspellcheck']); echo $check_spell->show(intval($RCI->getprop('enable_spellcheck')), ['value' => 1]); ?> Make use of the spell checker

spellcheck_engine

'_spellcheck_engine', 'id' => 'cfgspellcheckengine']); if (extension_loaded('pspell')) { $select_spell->add('Pspell', 'pspell'); } if (extension_loaded('enchant')) { $select_spell->add('Enchant', 'enchant'); } $select_spell->add('Googie', 'googie'); $select_spell->add('ATD', 'atd'); echo $select_spell->show($RCI->is_post ? $_POST['_spellcheck_engine'] : 'pspell'); ?>

Which spell checker to use

Googie implies that the message content will be sent to external server 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); $input_ilevel->add('one identity with possibility to edit only signature', 4); echo $input_ilevel->show($RCI->getprop('identities_level'), 0); ?>

Level of identities access

Defines what users can do with their identities.

log_driver

'_log_driver', 'id' => 'cfglogdriver']); $select_log_driver->add(['file', 'syslog', 'stdout'], ['file', 'syslog', 'stdout']); 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, 'stdout' writes to the process' STDOUT file descriptor.

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); if (defined('LOG_MAIL')) { $input_syslogfacility->add('mail subsystem', LOG_MAIL); } if (defined('LOG_LOCAL0')) { $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.

db_dsnw

Database settings for read/write operations:

'_dbtype', 'id' => 'cfgdbtype']); foreach ($RCI->supported_dbs as $database => $ext) { if (extension_loaded($ext)) { $select_dbtype->add($database, substr($ext, 4)); } } $input_dbhost = new html_inputfield(['name' => '_dbhost', 'size' => 20, 'id' => 'cfgdbhos']); $input_dbname = new html_inputfield(['name' => '_dbname', 'size' => 20, 'id' => 'cfgdbname']); $input_dbuser = new html_inputfield(['name' => '_dbuser', 'size' => 20, 'id' => 'cfgdbuser']); $input_dbpass = new html_inputfield(['name' => '_dbpass', 'size' => 20, 'id' => 'cfgdbpass']); $dsnw = rcube_db::parse_dsn($RCI->getprop('db_dsnw')); echo $select_dbtype->show($RCI->is_post ? $_POST['_dbtype'] : ($dsnw['phptype'] ?? '')); echo 'Database type
'; echo $input_dbhost->show($RCI->is_post ? $_POST['_dbhost'] : ($dsnw['hostspec'] ?? '')); echo 'Database server (omit for sqlite)
'; echo $input_dbname->show($RCI->is_post ? $_POST['_dbname'] : ($dsnw['database'] ?? '')); echo 'Database name (use absolute path and filename for sqlite)
'; echo $input_dbuser->show($RCI->is_post ? $_POST['_dbuser'] : ($dsnw['username'] ?? '')); echo 'Database user name (needs write permissions) (omit for sqlite)
'; echo $input_dbpass->show($RCI->is_post ? $_POST['_dbpass'] : ($dsnw['password'] ?? '')); echo 'Database password (omit for sqlite)
'; ?>

db_prefix

'_db_prefix', 'size' => 20, 'id' => 'cfgdbprefix']); echo $input_prefix->show($RCI->getprop('db_prefix')); ?>

Optional prefix that will be added to database object names (tables and sequences).

imap_host

'_imap_host[]', 'size' => 30]); $default_hosts = $RCI->get_hostlist(); if (empty($default_hosts)) { $default_hosts = ['']; } $i = 0; foreach ($default_hosts as $host) { echo '

' . $text_imaphost->show($host); if ($i++ > 0) { echo 'remove'; } echo '

'; } ?>

add

The IMAP host(s) chosen to perform the log-in

Leave blank to show a textbox at login. To use SSL/STARTTLS connection add ssl:// or tls:// prefix. It can also contain the port number, e.g. tls://imap.domain.tld:143.

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')), ['value' => 1]); ?> Automatically create a new Roundcube user when log-in the first time

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. Note: folder must include namespace prefix if any.

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. Note: folder must include namespace prefix if any.

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. Note: folder must include namespace prefix if any.

junk_mbox

'_junk_mbox', 'size' => 20, 'id' => 'cfgjunkmbox']); echo $text_junkmbox->show($RCI->getprop('junk_mbox')); ?>

Store spam messages in this folder

Note: folder must include namespace prefix if any.

smtp_host

'_smtp_host', 'size' => 30, 'id' => 'cfgsmtphost']); echo $text_smtphost->show($RCI->getprop('smtp_host', 'localhost:587')); ?>

Use this host for sending mails

To use SSL/STARTTLS connection add ssl:// or tls:// prefix. It can also contain the port number, e.g. tls://smtp.domain.tld:587.

smtp_user/smtp_pass

'_smtp_user', 'size' => 20, 'id' => 'cfgsmtpuser']); $text_smtppass = new html_inputfield(['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' || !empty($_POST['_smtp_user_u']) ? 1 : 0, ['value' => 1]); ?> Use the current IMAP username and password for SMTP authentication

smtp_log

'_smtp_log', 'id' => 'cfgsmtplog']); echo $check_smtplog->show(intval($RCI->getprop('smtp_log')), ['value' => 1]); ?> Log sent messages in {log_dir}/sendmail or to syslog.

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', 'id' => 'cfgskin']); $skins = $RCI->list_skins(); $input_skin->add($skins, $skins); echo $input_skin->show($RCI->getprop('skin')); ?>

Name of interface skin (folder in /skins)

mail_pagesize *

getprop('mail_pagesize'); if (!$pagesize) { $pagesize = $RCI->getprop('pagesize'); } $input_pagesize = new html_inputfield(['name' => '_mail_pagesize', 'size' => 6, 'id' => 'cfgmailpagesize']); echo $input_pagesize->show($pagesize); ?>

Show up to X items in the mail messages list view.

addressbook_pagesize *

getprop('addressbook_pagesize'); if (!$pagesize) { $pagesize = $RCI->getprop('pagesize'); } $input_pagesize = new html_inputfield(['name' => '_addressbook_pagesize', 'size' => 6, 'id' => 'cfgabookpagesize']); echo $input_pagesize->show($pagesize); ?>

Show up to X items in the contacts list view.

prefer_html *

'_prefer_html', 'id' => 'cfghtmlview', 'value' => 1]); echo $check_htmlview->show(intval($RCI->getprop('prefer_html'))); ?> Prefer displaying HTML messages

htmleditor *

Compose HTML formatted messages '_htmleditor', 'id' => 'cfghtmlcompose']); $select_htmlcomp->add('never', 0); $select_htmlcomp->add('always', 1); $select_htmlcomp->add('on reply to HTML message only', 2); echo $select_htmlcomp->show(intval($RCI->getprop('htmleditor'))); ?>

draft_autosave *

Save compose message every '_draft_autosave', 'id' => 'cfgautosave']); $select_autosave->add('never', 0); foreach ([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, otherwise ask the user', 4 => 'send receipt to user contacts, otherwise ignore', 2 => 'ignore', ]; $select_mdnreq = new html_select(['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(strval($RCI->getprop('mime_param_folding'))); ?>

How to encode attachment long/non-ascii names

*  These settings are defaults for the user preferences

list_plugins(); foreach ($plugins as $p) { $p_check = new html_checkbox(['name' => '_plugins_'.$p['name'], 'id' => 'cfgplugin_'.$p['name'], 'value' => $p['name']]); echo '

'; echo $p_check->show($p['enabled'] ? $p['name'] : 0); echo ' ' . $p['name'] . '

'; echo '' . $p['desc'] . '

'; } ?>

Please consider checking dependencies of enabled plugins