Ignore:
Timestamp:
Mar 5, 2010 4:47:32 AM (3 years ago)
Author:
alec
Message:
  • Support/Require? tls:// prefix in 'smtp_server' option for TLS connections
  • "Split" config file into sections
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/roundcubemail/config/main.inc.php.dist

    r3318 r3324  
    1515$rcmail_config = array(); 
    1616 
     17// ---------------------------------- 
     18// LOGGING/DEBUGGING 
     19// ---------------------------------- 
     20 
    1721// system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace 
    1822$rcmail_config['debug_level'] = 1; 
     
    3236$rcmail_config['syslog_facility'] = LOG_USER; 
    3337 
    34 // use this folder to store log files (must be writeable for apache user) 
    35 // This is used by the 'file' log driver. 
    36 $rcmail_config['log_dir'] = 'logs/'; 
    37  
    38 // use this folder to store temp files (must be writeable for apache user) 
    39 $rcmail_config['temp_dir'] = 'temp/'; 
    40  
    41 // List of active plugins (in plugins/ directory) 
    42 $rcmail_config['plugins'] = array(); 
    43  
    44 // enable caching of messages and mailbox data in the local database. 
    45 // this is recommended if the IMAP server does not run on the same machine 
    46 $rcmail_config['enable_caching'] = FALSE; 
    47  
    48 // lifetime of message cache 
    49 // possible units: s, m, h, d, w 
    50 $rcmail_config['message_cache_lifetime'] = '10d'; 
    51  
    52 // enforce connections over https 
    53 // with this option enabled, all non-secure connections will be redirected. 
    54 // set the port for the ssl connection as value of this option if it differs from the default 443 
    55 $rcmail_config['force_https'] = FALSE; 
    56  
    57 // automatically create a new RoundCube user when log-in the first time. 
    58 // a new user will be created once the IMAP login succeeds. 
    59 // set to false if only registered users can use this service 
    60 $rcmail_config['auto_create_user'] = TRUE; 
     38// Log sent messages 
     39$rcmail_config['smtp_log'] = true; 
     40 
     41// Log successful logins 
     42$rcmail_config['log_logins'] = false; 
     43 
     44// Log SQL queries to <log_dir>/sql or to syslog 
     45$rcmail_config['sql_debug'] = false; 
     46 
     47// Log IMAP conversation to <log_dir>/imap or to syslog 
     48$rcmail_config['imap_debug'] = false; 
     49 
     50// Log LDAP conversation to <log_dir>/ldap or to syslog 
     51$rcmail_config['ldap_debug'] = false; 
     52 
     53// Log SMTP conversation to <log_dir>/smtp or to syslog 
     54$rcmail_config['smtp_debug'] = false; 
     55 
     56// ---------------------------------- 
     57// IMAP 
     58// ---------------------------------- 
    6159 
    6260// the mail host chosen to perform the log-in 
     
    7876$rcmail_config['imap_delimiter'] = null; 
    7977 
     78// ---------------------------------- 
     79// SMTP 
     80// ---------------------------------- 
     81 
     82// SMTP server host (for sending mails). 
     83// To use SSL/TLS connection, enter hostname with prefix ssl:// or tls:// 
     84// If left blank, the PHP mail() function is used 
     85// Use %h variable as replacement for user's IMAP hostname 
     86$rcmail_config['smtp_server'] = ''; 
     87 
     88// SMTP port (default is 25; 465 for SSL) 
     89$rcmail_config['smtp_port'] = 25; 
     90 
     91// SMTP username (if required) if you use %u as the username RoundCube 
     92// will use the current username for login 
     93$rcmail_config['smtp_user'] = ''; 
     94 
     95// SMTP password (if required) if you use %p as the password RoundCube 
     96// will use the current user's password for login 
     97$rcmail_config['smtp_pass'] = ''; 
     98 
     99// SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use 
     100// best server supported one) 
     101$rcmail_config['smtp_auth_type'] = ''; 
     102 
     103// SMTP HELO host  
     104// Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages  
     105// Leave this blank and you will get the server variable 'server_name' or  
     106// localhost if that isn't defined.  
     107$rcmail_config['smtp_helo_host'] = ''; 
     108 
     109// ---------------------------------- 
     110// SYSTEM 
     111// ---------------------------------- 
     112 
     113// THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA. 
     114// ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING! 
     115$rcmail_config['enable_installer'] = false; 
     116 
     117// use this folder to store log files (must be writeable for apache user) 
     118// This is used by the 'file' log driver. 
     119$rcmail_config['log_dir'] = 'logs/'; 
     120 
     121// use this folder to store temp files (must be writeable for apache user) 
     122$rcmail_config['temp_dir'] = 'temp/'; 
     123 
     124// enable caching of messages and mailbox data in the local database. 
     125// this is recommended if the IMAP server does not run on the same machine 
     126$rcmail_config['enable_caching'] = false; 
     127 
     128// lifetime of message cache 
     129// possible units: s, m, h, d, w 
     130$rcmail_config['message_cache_lifetime'] = '10d'; 
     131 
     132// enforce connections over https 
     133// with this option enabled, all non-secure connections will be redirected. 
     134// set the port for the ssl connection as value of this option if it differs from the default 443 
     135$rcmail_config['force_https'] = false; 
     136 
     137// automatically create a new RoundCube user when log-in the first time. 
     138// a new user will be created once the IMAP login succeeds. 
     139// set to false if only registered users can use this service 
     140$rcmail_config['auto_create_user'] = true; 
     141 
     142// Includes should be interpreted as PHP files 
     143$rcmail_config['skin_include_php'] = false; 
     144 
     145// Session lifetime in minutes 
     146// must be greater than 'keep_alive'/60 
     147$rcmail_config['session_lifetime'] = 10; 
     148 
     149// check client IP in session athorization 
     150$rcmail_config['ip_check'] = false; 
     151 
     152// Use an additional frequently changing cookie to athenticate user sessions. 
     153// There have been problems reported with this feature. 
     154$rcmail_config['double_auth'] = false; 
     155 
     156// this key is used to encrypt the users imap password which is stored 
     157// in the session record (and the client cookie if remember password is enabled). 
     158// please provide a string of exactly 24 chars. 
     159$rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str'; 
     160 
    80161// Automatically add this domain to user names for login 
    81162// Only for IMAP servers that require full e-mail addresses for login 
     
    96177$rcmail_config['virtuser_query'] = ''; 
    97178 
    98 // SMTP server host (for sending mails). 
    99 // To use SSL connection, set ssl://smtp.host.com 
    100 // WARNING: Don't use 'tls://' prefix, TLS is used by default if possible 
    101 // If left blank, the PHP mail() function is used 
    102 // Use %h variable as replacement for user's IMAP hostname 
    103 $rcmail_config['smtp_server'] = ''; 
    104  
    105 // SMTP port (default is 25; 465 for SSL) 
    106 $rcmail_config['smtp_port'] = 25; 
    107  
    108 // SMTP username (if required) if you use %u as the username RoundCube 
    109 // will use the current username for login 
    110 $rcmail_config['smtp_user'] = ''; 
    111  
    112 // SMTP password (if required) if you use %p as the password RoundCube 
    113 // will use the current user's password for login 
    114 $rcmail_config['smtp_pass'] = ''; 
    115  
    116 // SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use 
    117 // best server supported one) 
    118 $rcmail_config['smtp_auth_type'] = ''; 
    119  
    120 // SMTP HELO host  
    121 // Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages  
    122 // Leave this blank and you will get the server variable 'server_name' or  
    123 // localhost if that isn't defined.  
    124 $rcmail_config['smtp_helo_host'] = ''; 
    125  
    126179// Password charset. 
    127180// Use it if your authentication backend doesn't support UTF-8. 
     
    129182$rcmail_config['password_charset'] = 'ISO-8859-1'; 
    130183 
    131 // Log sent messages 
    132 $rcmail_config['smtp_log'] = TRUE; 
    133  
    134 // Log SQL queries to <log_dir>/sql or to syslog 
    135 $rcmail_config['sql_debug'] = false; 
    136  
    137 // Log IMAP conversation to <log_dir>/imap or to syslog 
    138 $rcmail_config['imap_debug'] = false; 
    139  
    140 // Log LDAP conversation to <log_dir>/ldap or to syslog 
    141 $rcmail_config['ldap_debug'] = false; 
    142  
    143 // Log SMTP conversation to <log_dir>/smtp or to syslog 
    144 $rcmail_config['smtp_debug'] = false; 
    145  
    146184// How many seconds must pass between emails sent by a user 
    147185$rcmail_config['sendmail_delay'] = 0; 
     186 
     187// add this user-agent to message headers when sending 
     188$rcmail_config['useragent'] = 'RoundCube Webmail/'.RCMAIL_VERSION; 
     189 
     190// use this name to compose page titles 
     191$rcmail_config['product_name'] = 'RoundCube Webmail'; 
     192 
     193// try to load host-specific configuration 
     194// see http://trac.roundcube.net/wiki/Howto_Config for more details 
     195$rcmail_config['include_host_config'] = false; 
     196 
     197// path to a text file which will be added to each sent message 
     198// paths are relative to the RoundCube root folder 
     199$rcmail_config['generic_message_footer'] = ''; 
     200 
     201// add a received header to outgoing mails containing the creators IP and hostname 
     202$rcmail_config['http_received_header'] = false; 
     203 
     204// Whether or not to encrypt the IP address and the host name 
     205// these could, in some circles, be considered as sensitive information; 
     206// however, for the administrator, these could be invaluable help 
     207// when tracking down issues. 
     208$rcmail_config['http_received_header_encrypt'] = false; 
     209 
     210// this string is used as a delimiter for message headers when sending 
     211// leave empty for auto-detection 
     212$rcmail_config['mail_header_delimiter'] = NULL; 
     213 
     214// session domain: .example.org 
     215$rcmail_config['session_domain'] = ''; 
     216 
     217// don't allow these settings to be overriden by the user 
     218$rcmail_config['dont_override'] = array(); 
     219 
     220// Set identities access level: 
     221// 0 - many identities with possibility to edit all params 
     222// 1 - many identities with possibility to edit all params but not email address 
     223// 2 - one identity with possibility to edit all params 
     224// 3 - one identity with possibility to edit all params but not email address 
     225$rcmail_config['identities_level'] = 0; 
     226 
     227// mime magic database 
     228$rcmail_config['mime_magic'] = '/usr/share/misc/magic'; 
     229 
     230// Enable DNS checking for e-mail address validation 
     231$rcmail_config['email_dns_check'] = false; 
     232 
     233// ---------------------------------- 
     234// PLUGINS 
     235// ---------------------------------- 
     236 
     237// List of active plugins (in plugins/ directory) 
     238$rcmail_config['plugins'] = array(); 
     239 
     240// ---------------------------------- 
     241// USER INTERFACE 
     242// ---------------------------------- 
     243 
     244// default sort col 
     245$rcmail_config['message_sort_col'] = 'date'; 
     246 
     247// default sort order 
     248$rcmail_config['message_sort_order'] = 'DESC'; 
    148249 
    149250// These cols are shown in the message list. Available cols are: 
     
    151252$rcmail_config['list_cols'] = array('subject', 'from', 'date', 'size', 'flag', 'attachment'); 
    152253 
    153 // Includes should be interpreted as PHP files 
    154 $rcmail_config['skin_include_php'] = FALSE; 
    155  
    156 // Session lifetime in minutes 
    157 // must be greater than 'keep_alive'/60 
    158 $rcmail_config['session_lifetime'] = 10; 
    159  
    160 // check client IP in session athorization 
    161 $rcmail_config['ip_check'] = false; 
    162  
    163 // Use an additional frequently changing cookie to athenticate user sessions. 
    164 // There have been problems reported with this feature. 
    165 $rcmail_config['double_auth'] = false; 
    166  
    167 // this key is used to encrypt the users imap password which is stored 
    168 // in the session record (and the client cookie if remember password is enabled). 
    169 // please provide a string of exactly 24 chars. 
    170 $rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str'; 
    171  
    172254// the default locale setting (leave empty for auto-detection) 
    173255// RFC1766 formatted language name like en_US, de_DE, de_CH, fr_FR, pt_BR 
     
    183265$rcmail_config['date_today'] = 'H:i'; 
    184266 
    185 // add this user-agent to message headers when sending 
    186 $rcmail_config['useragent'] = 'RoundCube Webmail/'.RCMAIL_VERSION; 
    187  
    188 // use this name to compose page titles 
    189 $rcmail_config['product_name'] = 'RoundCube Webmail'; 
    190  
    191267// store draft message is this mailbox 
    192268// leave blank if draft messages should not be stored 
     
    209285 
    210286// automatically create the above listed default folders on login 
    211 $rcmail_config['create_default_folders'] = FALSE; 
     287$rcmail_config['create_default_folders'] = false; 
    212288 
    213289// protect the default folders from renames, deletes, and subscription changes 
    214 $rcmail_config['protect_default_folders'] = TRUE; 
    215  
    216 // if in your system 0 quota means no limit set this option to TRUE  
    217 $rcmail_config['quota_zero_as_unlimited'] = FALSE; 
     290$rcmail_config['protect_default_folders'] = true; 
     291 
     292// if in your system 0 quota means no limit set this option to true  
     293$rcmail_config['quota_zero_as_unlimited'] = false; 
    218294 
    219295// Behavior if a received message requests a message delivery notification (read receipt) 
     
    227303// Since Google only accepts connections over https your PHP installatation 
    228304// requires to be compiled with Open SSL support 
    229 $rcmail_config['enable_spellcheck'] = TRUE; 
     305$rcmail_config['enable_spellcheck'] = true; 
    230306 
    231307// Set the spell checking engine. 'googie' is the default. 'pspell' is also available, 
     
    244320$rcmail_config['spellcheck_languages'] = NULL; 
    245321 
    246 // path to a text file which will be added to each sent message 
    247 // paths are relative to the RoundCube root folder 
    248 $rcmail_config['generic_message_footer'] = ''; 
    249  
    250 // add a received header to outgoing mails containing the creators IP and hostname 
    251 $rcmail_config['http_received_header'] = false; 
    252  
    253 // Whether or not to encrypt the IP address and the host name 
    254 // these could, in some circles, be considered as sensitive information; 
    255 // however, for the administrator, these could be invaluable help 
    256 // when tracking down issues. 
    257 $rcmail_config['http_received_header_encrypt'] = false; 
    258  
    259 // this string is used as a delimiter for message headers when sending 
    260 // leave empty for auto-detection 
    261 $rcmail_config['mail_header_delimiter'] = NULL; 
    262  
    263 // session domain: .example.org 
    264 $rcmail_config['session_domain'] = ''; 
     322// don't let users set pagesize to more than this value if set 
     323$rcmail_config['max_pagesize'] = 200; 
     324 
     325/** 
     326 * 'Delete always' 
     327 * This setting reflects if mail should be always deleted 
     328 * when moving to Trash fails. This is necessary in some setups 
     329 * when user is over quota and Trash is included in the quota. 
     330 */ 
     331$rcmail_config['delete_always'] = false; 
     332 
     333// Minimal value of user's 'keep_alive' setting (in seconds) 
     334// Must be less than 'session_lifetime' 
     335$rcmail_config['min_keep_alive'] = 60; 
     336 
     337// ---------------------------------- 
     338// ADDRESSBOOK SETTINGS 
     339// ---------------------------------- 
    265340 
    266341// This indicates which type of address book to use. Possible choises: 
     
    327402$rcmail_config['autocomplete_addressbooks'] = array('sql'); 
    328403 
    329 // don't allow these settings to be overriden by the user 
    330 $rcmail_config['dont_override'] = array(); 
    331  
    332 // Set identities access level: 
    333 // 0 - many identities with possibility to edit all params 
    334 // 1 - many identities with possibility to edit all params but not email address 
    335 // 2 - one identity with possibility to edit all params 
    336 // 3 - one identity with possibility to edit all params but not email address 
    337 $rcmail_config['identities_level'] = 0; 
    338  
    339 // try to load host-specific configuration 
    340 // see http://trac.roundcube.net/wiki/Howto_Config for more details 
    341 $rcmail_config['include_host_config'] = false; 
    342  
    343 // don't let users set pagesize to more than this value if set 
    344 $rcmail_config['max_pagesize'] = 200; 
    345  
    346 // mime magic database 
    347 $rcmail_config['mime_magic'] = '/usr/share/misc/magic'; 
    348  
    349 // default sort col 
    350 $rcmail_config['message_sort_col'] = 'date'; 
    351  
    352 // default sort order 
    353 $rcmail_config['message_sort_order'] = 'DESC'; 
    354  
    355 // THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA. 
    356 // ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING! 
    357 $rcmail_config['enable_installer'] = false; 
    358  
    359 // Log successful logins 
    360 $rcmail_config['log_logins'] = false; 
    361  
    362 /** 
    363  * 'Delete always' 
    364  * This setting reflects if mail should be always deleted 
    365  * when moving to Trash fails. This is necessary in some setups 
    366  * when user is over quota and Trash is included in the quota. 
    367  */ 
    368 $rcmail_config['delete_always'] = false; 
    369  
    370 // Minimal value of user's 'keep_alive' setting (in seconds) 
    371 // Must be less than 'session_lifetime' 
    372 $rcmail_config['min_keep_alive'] = 60; 
    373  
    374 // Enable DNS checking for e-mail address validation 
    375 $rcmail_config['email_dns_check'] = false; 
    376  
    377 /***** these settings can be overwritten by user's preferences *****/ 
     404// ---------------------------------- 
     405// USER PREFERENCES 
     406// ---------------------------------- 
    378407 
    379408// skin name: folder from skins/ 
     
    390419 
    391420// prefer displaying HTML messages 
    392 $rcmail_config['prefer_html'] = TRUE; 
     421$rcmail_config['prefer_html'] = true; 
    393422 
    394423// display remote inline images 
     
    399428 
    400429// compose html formatted messages by default 
    401 $rcmail_config['htmleditor'] = FALSE; 
     430$rcmail_config['htmleditor'] = false; 
    402431 
    403432// show pretty dates as standard 
    404 $rcmail_config['prettydate'] = TRUE; 
     433$rcmail_config['prettydate'] = true; 
    405434 
    406435// save compose message every 300 seconds (5min) 
     
    408437 
    409438// default setting if preview pane is enabled 
    410 $rcmail_config['preview_pane'] = FALSE; 
     439$rcmail_config['preview_pane'] = false; 
    411440 
    412441// focus new window if new message arrives 
     
    414443 
    415444// Clear Trash on logout 
    416 $rcmail_config['logout_purge'] = FALSE; 
     445$rcmail_config['logout_purge'] = false; 
    417446 
    418447// Compact INBOX on logout 
    419 $rcmail_config['logout_expunge'] = FALSE; 
     448$rcmail_config['logout_expunge'] = false; 
    420449 
    421450// Display attached images below the message body  
    422 $rcmail_config['inline_images'] = TRUE; 
     451$rcmail_config['inline_images'] = true; 
    423452 
    424453// Encoding of long/non-ascii attachment names: 
     
    428457$rcmail_config['mime_param_folding'] = 1; 
    429458 
    430 // Set TRUE if deleted messages should not be displayed 
     459// Set true if deleted messages should not be displayed 
    431460// This will make the application run slower 
    432 $rcmail_config['skip_deleted'] = FALSE; 
     461$rcmail_config['skip_deleted'] = false; 
    433462 
    434463// Set true to Mark deleted messages as read as well as deleted 
    435464// False means that a message's read status is not affected by marking it as deleted 
    436 $rcmail_config['read_when_deleted'] = TRUE; 
    437  
    438 // Set to TRUE to newer delete messages immediately 
     465$rcmail_config['read_when_deleted'] = true; 
     466 
     467// Set to true to newer delete messages immediately 
    439468// Use 'Purge' to remove messages marked as deleted  
    440 $rcmail_config['flag_for_deletion'] = FALSE; 
     469$rcmail_config['flag_for_deletion'] = false; 
    441470 
    442471// Default interval for keep-alive/check-recent requests (in seconds) 
     
    445474 
    446475// If true all folders will be checked for recent messages 
    447 $rcmail_config['check_all_folders'] = FALSE; 
     476$rcmail_config['check_all_folders'] = false; 
    448477 
    449478// If true, after message delete/move, the next message will be displayed 
    450 $rcmail_config['display_next'] = FALSE; 
     479$rcmail_config['display_next'] = false; 
    451480 
    452481// If true, messages list will be sorted by message index instead of message date 
    453 $rcmail_config['index_sort'] = TRUE; 
     482$rcmail_config['index_sort'] = true; 
    454483 
    455484// When replying place cursor above original message (top posting) 
    456 $rcmail_config['top_posting'] = FALSE; 
     485$rcmail_config['top_posting'] = false; 
    457486 
    458487// When replying strip original signature from message 
    459 $rcmail_config['strip_existing_sig'] = TRUE; 
     488$rcmail_config['strip_existing_sig'] = true; 
    460489 
    461490// Show signature: 
     
    467496 
    468497// When replying or forwarding place sender's signature above existing message 
    469 $rcmail_config['sig_above'] = FALSE; 
     498$rcmail_config['sig_above'] = false; 
    470499 
    471500// Use MIME encoding (quoted-printable) for 8bit characters in message body 
    472 $rcmail_config['force_7bit'] = FALSE; 
     501$rcmail_config['force_7bit'] = false; 
    473502 
    474503// Defaults of the search field configuration. 
Note: See TracChangeset for help on using the changeset viewer.