Author Topic: Need help with config (main.inc.php)  (Read 53806 times)

Offline TigerDE2

  • Newbie
  • *
  • Posts: 4
Need help with config (main.inc.php)
« on: January 28, 2008, 05:02:26 PM »
Hi all!

My mail server is located at mail.example.com, the mail address is mail@example.com. The login name (mailfile1) differs from the mail address...
How do I have to set the following variables in order to get roundcube working?
Code: [Select]
$rcmail_config['default_host'] = '';
$rcmail_config['username_domain'] = '';
$rcmail_config['smtp_server'] = '';

What's the difference between those/what are they good for? (I don't quite get the comments in the config file, I'm afarid...)

Regards,

Christian

Offline jasonar

  • Jr. Member
  • **
  • Posts: 18
Re: Need help with config (main.inc.php)
« Reply #1 on: January 29, 2008, 02:06:39 AM »
It's kinda confusing to set up rc, I'll help you out.

Just for an example, I'll use "site.com".

this is what it should look like:

Code: [Select]
$rcmail_config['default_host'] = 'localhost';
$rcmail_config['username_domain'] = 'site.com';
$rcmail_config['smtp_server'] = 'mail.site.com';

the default port should be "2525" also.

If you have any more questions on this let me know, support seems kinda slow here, but I try to help out as much as possible. And just a tip only setting ^^ those 'might' not make it work properly If you wan I can post a complete 'main.inc.php' file for you to use as an example. Let me know ok?

John

Offline TigerDE2

  • Newbie
  • *
  • Posts: 4
Re: Need help with config (main.inc.php)
« Reply #2 on: January 29, 2008, 03:53:08 AM »
Hi John,

Thank you for your reply. I'd appreciate if you could post a sample configuration file. :)
Especially, as I just realised I forgot to ask about $rcmail_config['mail_domain'] = '';

Thanks a million in advance. :)

Kind regards,

Christian

Offline TigerDE2

  • Newbie
  • *
  • Posts: 4
Re: Need help with config (main.inc.php)
« Reply #3 on: January 29, 2008, 04:05:38 AM »
I tried the settings you suggested; roundcube lets me login now. Thanks. :)

Another thing I just noticed, though:
I log in with my username (mailfile1) and password. So, roundcube sets the e-mail address to mailfile1@example.com. However, it's actually mail@example.com. I suppose I'll have to use the "virtuser_" settings?

Regards,

Christian

Answer to self: Yes. I created a file called "virtusers" with the following content:
Quote
mail@example.com mailfile1
I then created a folder "virtusers" and uploaded the file and the .htaccess from the temp folder into it.
Last thing, I changed a line in main.inc.php :
Code: [Select]
$rcmail_config['virtuser_file'] = 'virtusers/virtusers';Works like a charm! :)

Offline jasonar

  • Jr. Member
  • **
  • Posts: 18
Re: Need help with config (main.inc.php)
« Reply #4 on: January 29, 2008, 06:13:28 PM »
Hi, sry for the long wait. Here is a sample file, the way this file is set is the way my site is setup and it works great. If you have any more questions, I'm here most of the time.


The site that is used in this file is "example.com"

Code: [Select]
<?php


$rcmail_config 
= array();


// system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace
$rcmail_config['debug_level'] = 1;

// enable caching of messages and mailbox data in the local database.
// this is recommended if the IMAP server does not run on the same machine
$rcmail_config['enable_caching'] = TRUE;

// lifetime of message cache
// possible units: s, m, h, d, w
$rcmail_config['message_cache_lifetime'] = '10d';

// automatically create a new RoundCube user when log-in the first time.
// a new user will be created once the IMAP login succeeds.
// set to false if only registered users can use this service
$rcmail_config['auto_create_user'] = TRUE;

// the mail host chosen to perform the log-in
// leave blank to show a textbox at login, give a list of hosts
// to display a pulldown menu or set one host as string.
// To use SSL connection, enter ssl://hostname:993
$rcmail_config['default_host'] = 'localhost';

// TCP port used for IMAP connections
$rcmail_config['default_port'] = 143;

// Automatically add this domain to user names for login
// Only for IMAP servers that require full e-mail addresses for login
// Specify an array with 'host' => 'domain' values to support multiple hosts
$rcmail_config['username_domain'] = 'example.com';

// This domain will be used to form e-mail addresses of new users
// Specify an array with 'host' => 'domain' values to support multiple hosts
$rcmail_config['mail_domain'] = 'example.com';

// Path to a virtuser table file to resolve user names and e-mail addresses
$rcmail_config['virtuser_file'] = '';

// Query to resolve user names and e-mail addresses from the database
// %u will be replaced with the current username for login.
// The query should select the user's e-mail address as first col
$rcmail_config['virtuser_query'] = '%u';

// use this host for sending mails.
// to use SSL connection, set ssl://smtp.host.com
// if left blank, the PHP mail() function is used
$rcmail_config['smtp_server'] = 'mail.example.com';

// SMTP port (default is 25; 465 for SSL)
$rcmail_config['smtp_port'] = 2525;

// SMTP username (if required) if you use %u as the username RC
// will use the current username for login
$rcmail_config['smtp_user'] = '%u';

// SMTP password (if required) if you use %p as the password RC
// will use the current user's password for login
$rcmail_config['smtp_pass'] = '%p';

// SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
// best server supported one)
$rcmail_config['smtp_auth_type'] = '';

// SMTP HELO host 
// Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages 
// Leave this blank and you will get the server variable 'server_name' or 
// localhost if that isn't defined. 
$rcmail_config['smtp_helo_host'] = '';

// Log sent messages
$rcmail_config['smtp_log'] = TRUE;

// these cols are shown in the message list
// available cols are: subject, from, to, cc, replyto, date, size, encoding
$rcmail_config['list_cols'] = array('subject''from''date''size');

// relative path to the skin folder
$rcmail_config['skin_path'] = 'skins/default/';

// includes should be interpreted as PHP files
$rcmail_config['skin_include_php'] = FALSE;

// use this folder to store temp files (must be writebale for apache user)
$rcmail_config['temp_dir'] = 'temp/';

// use this folder to store log files (must be writebale for apache user)
$rcmail_config['log_dir'] = 'logs/';

// session lifetime in minutes
$rcmail_config['session_lifetime'] = 10;

// check client IP in session athorization
$rcmail_config['ip_check'] = TRUE;

// Use an additional frequently changing cookie to athenticate user sessions.
// There have been problems reported with this feature.
$rcmail_config['double_auth'] = false;

// this key is used to encrypt the users imap password which is stored
// in the session record (and the client cookie if remember password is enabled).
// please provide a string of exactly 24 chars.
$rcmail_config['des_key'] = 'mail-!24ByteDESkey*Str';

// the default locale setting
$rcmail_config['locale_string'] = 'en';

// use this format for short date display
$rcmail_config['date_short'] = 'D H:i';

// use this format for detailed date/time formatting
$rcmail_config['date_long'] = 'd.m.Y H:i';

// use this format for today's date display
$rcmail_config['date_today'] = 'H:i';

// add this user-agent to message headers when sending
$rcmail_config['useragent'] = 'Exmple Mail';

// use this name to compose page titles
$rcmail_config['product_name'] = 'Example Mail';

// only list folders within this path
$rcmail_config['imap_root'] = '';

// store draft message is this mailbox
// leave blank if draft messages should not be stored
$rcmail_config['drafts_mbox'] = 'Drafts';

// store spam messages in this mailbox
$rcmail_config['junk_mbox'] = 'Spam';

// store sent message is this mailbox
// leave blank if sent messages should not be stored
$rcmail_config['sent_mbox'] = 'Sent';

// move messages to this folder when deleting them
// leave blank if they should be deleted directly
$rcmail_config['trash_mbox'] = 'Trash';

// display these folders separately in the mailbox list.
// these folders will automatically be created if they do not exist
$rcmail_config['default_imap_folders'] = array('INBOX''Drafts''Sent''Junk''Trash');

// protect the default folders from renames, deletes, and subscription changes
$rcmail_config['protect_default_folders'] = TRUE;

// Set TRUE if deleted messages should not be displayed
// This will make the application run slower
$rcmail_config['skip_deleted'] = FALSE;

// Set true to Mark deleted messages as read as well as deleted
// False means that a message's read status is not affected by marking it as deleted
$rcmail_config['read_when_deleted'] = False;

// When a Trash folder is not present and a message is deleted, flag 
// the message for deletion rather than deleting it immediately. Setting this to 
// false causes deleted messages to be permanantly removed if there is no Trash folder
$rcmail_config['flag_for_deletion'] = TRUE;

// Make use of the built-in spell checker. It is based on GoogieSpell.
// Since Google only accepts connections over https your PHP installatation
// requires to be compiled with Open SSL support
$rcmail_config['enable_spellcheck'] = TRUE;

// For a locally installed Nox Spell Server, please specify the URI to call it.
// Get Nox Spell Server from [url]http://orangoo.com/labs/?page_id=72[/url]
// Leave empty to use the Google spell checking service, what means
// that the message content will be sent to Google in order to check spelling
$rcmail_config['spellcheck_uri'] = '';

// These languages can be selected for spell checking.
// Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch');
// Leave empty for default set of Google spell check languages
$rcmail_config['spellcheck_languages'] = NULL;

// path to a text file which will be added to each sent message
// paths are relative to the RoundCube root folder
$rcmail_config['generic_message_footer'] = 'sent-text-file.txt';

// this string is used as a delimiter for message headers when sending
// leave empty for auto-detection
$rcmail_config['mail_header_delimiter'] = NULL;

// in order to enable public ldap search, create a config array
// like the Verisign example below. if you would like to test, 
// simply uncomment the Verisign example 

$rcmail_config['ldap_public']['Xolur'] = array(
 
'name'     => 'Example.com',
 
'hosts'    => array('[url]www.example.com'[/url]),
 
'port'     => 389,
 
'base_dn'   => '',
 
'bind_dn'   => '',
 
'bind_pass'  => '',
 
'ldap_version' => 3,   // using LDAPv3
 
'search_fields' => array('mail''cn'), // fields to search in
 
'name_field'  => 'cn',  // this field represents the contact's name
 
'email_field' => 'mail'// this field represents the contact's e-mail
 
'surname_field' => 'sn',  // this field represents the contact's last name
 
'firstname_field' => 'gn'// this field represents the contact's first name
 
'scope'    => 'sub'// search mode: sub|base|list
 
'filter'    => '',   // used for basic listing (if not empty) and will be &'d with search queries. ex: (status=act)
 
'fuzzy_search' => true); // server allows wildcard search


// enable composing html formatted messages (experimental)
$rcmail_config['enable_htmleditor'] = TRUE;

// don't allow these settings to be overriden by the user
$rcmail_config['dont_override'] = array();

// list of configuration option names that need to be available in Javascript.
$rcmail_config['javascript_config'] = array('read_when_deleted''flag_for_deletion');

// try to load host-specific configuration
$rcmail_config['include_host_config'] = FALSE;


/***** these settings can be overwritten by user's preferences *****/

// show up to X items in list view
$rcmail_config['pagesize'] = 40;

// use this timezone to display date/time
$rcmail_config['timezone'] = intval(date('O'))/100 date('I');

// is daylight saving On?
$rcmail_config['dst_active'] = (bool)date('I');

// prefer displaying HTML messages
$rcmail_config['prefer_html'] = TRUE;

// show pretty dates as standard
$rcmail_config['prettydate'] = TRUE;

// default sort col
$rcmail_config['message_sort_col'] = 'date';

// default sort order
$rcmail_config['message_sort_order'] = 'DESC';

// save compose message every 300 seconds (5min)
$rcmail_config['draft_autosave'] = 300;

// don't let users set pagesize to more than this value if set
$rcmail_config['max_pagesize'] = 200;

// end of config file
?>


Offline TigerDE2

  • Newbie
  • *
  • Posts: 4
Re: Need help with config (main.inc.php)
« Reply #5 on: January 29, 2008, 07:30:39 PM »
Hi John,

Thanks an awful lot. I'll go through it and finetune my installation as soon as I'm through my exams (in about two weeks or so). :)

Kind regards,

Christian

Offline exec

  • Newbie
  • *
  • Posts: 2
Re: Need help with config (main.inc.php)
« Reply #6 on: February 06, 2008, 10:57:54 AM »
Dear jasonar ,

 I hope that you can help me too. I have trouble with main.inc.php configuration.  My mail server is :
  mail.something.bel.tr

 I tried everything but I have error:

PHP Notice: Could not connect to mail.something.bel.tr at port 143: A connection attempt failed because the connected party did not properly respond after a period of time, or established connection failed because connected host has failed to respond. in C:\Inetpub\vhosts\something.bel.tr\httpdocs\roundcube\program\include\bugs.inc on line 95


My main.inc.php content is above:


/*
 +-----------------------------------------------------------------------+
 | Main configuration file                        |
 |                                    |
 | This file is part of the RoundCube Webmail client           |
 | Copyright (C) 2005-2007, RoundCube Dev. - Switzerland         |
 | Licensed under the GNU GPL                      |
 |                                    |
 +-----------------------------------------------------------------------+

*/

$rcmail_config = array();


// system error reporting: 1 = log; 2 = report (not implemented yet), 4 = show, 8 = trace
$rcmail_config['debug_level'] = 1;

// enable caching of messages and mailbox data in the local database.
// this is recommended if the IMAP server does not run on the same machine
$rcmail_config['enable_caching'] = FALSE;

// lifetime of message cache
// possible units: s, m, h, d, w
$rcmail_config['message_cache_lifetime'] = '10d';

// automatically create a new RoundCube user when log-in the first time.
// a new user will be created once the IMAP login succeeds.
// set to false if only registered users can use this service
$rcmail_config['auto_create_user'] = FALSE;

// the mail host chosen to perform the log-in
// leave blank to show a textbox at login, give a list of hosts
// to display a pulldown menu or set one host as string.
// To use SSL connection, enter ssl://hostname:993
$rcmail_config['default_host'] = 'mail.sultankoy.bel.tr';

// TCP port used for IMAP connections
$rcmail_config['default_port'] = 143;

// Automatically add this domain to user names for login
// Only for IMAP servers that require full e-mail addresses for login
// Specify an array with 'host' => 'domain' values to support multiple hosts
$rcmail_config['username_domain'] = 'sultankoy.bel.tr';

// This domain will be used to form e-mail addresses of new users
// Specify an array with 'host' => 'domain' values to support multiple hosts
$rcmail_config['mail_domain'] = 'sultankoy.bel.tr';

// Path to a virtuser table file to resolve user names and e-mail addresses
$rcmail_config['virtuser_file'] = '';

// Query to resolve user names and e-mail addresses from the database
// %u will be replaced with the current username for login.
// The query should select the user's e-mail address as first col
$rcmail_config['virtuser_query'] = '%u';

// use this host for sending mails.
// to use SSL connection, set ssl://smtp.host.com
// if left blank, the PHP mail() function is used
$rcmail_config['smtp_server'] = 'mail.sultankoy.bel.tr';

// SMTP port (default is 25; 465 for SSL)
$rcmail_config['smtp_port'] = 2525;

// SMTP username (if required) if you use %u as the username RoundCube
// will use the current username for login
$rcmail_config['smtp_user'] = '%u';

// SMTP password (if required) if you use %p as the password RoundCube
// will use the current user's password for login
$rcmail_config['smtp_pass'] = '%p';

// SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use
// best server supported one)
$rcmail_config['smtp_auth_type'] = '';

// SMTP HELO host
// Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages
// Leave this blank and you will get the server variable 'server_name' or
// localhost if that isn't defined.
$rcmail_config['smtp_helo_host'] = '';

// Log sent messages
$rcmail_config['smtp_log'] = TRUE;

// these cols are shown in the message list
// available cols are: subject, from, to, cc, replyto, date, size, encoding
$rcmail_config['list_cols'] = array('subject', 'from', 'date', 'size');

// relative path to the skin folder
$rcmail_config['skin_path'] = 'skins/default/';

// includes should be interpreted as PHP files
$rcmail_config['skin_include_php'] = FALSE;

// use this folder to store temp files (must be writebale for apache user)
$rcmail_config['temp_dir'] = 'temp/';

// use this folder to store log files (must be writebale for apache user)
$rcmail_config['log_dir'] = 'logs/';

// session lifetime in minutes
$rcmail_config['session_lifetime'] = 10;

// check client IP in session athorization
$rcmail_config['ip_check'] = false;

// Use an additional frequently changing cookie to athenticate user sessions.
// There have been problems reported with this feature.
$rcmail_config['double_auth'] = false;

// this key is used to encrypt the users imap password which is stored
// in the session record (and the client cookie if remember password is enabled).
// please provide a string of exactly 24 chars.
$rcmail_config['des_key'] = 'rcmail-!24ByteDESkey*Str';

// the default locale setting
$rcmail_config['locale_string'] = 'en';

// use this format for short date display
$rcmail_config['date_short'] = 'D H:i';

// use this format for detailed date/time formatting
$rcmail_config['date_long'] = 'd.m.Y H:i';

// use this format for today's date display
$rcmail_config['date_today'] = 'H:i';

// add this user-agent to message headers when sending
$rcmail_config['useragent'] = 'RoundCube Webmail/0.1-rc2';

// use this name to compose page titles
$rcmail_config['product_name'] = 'RoundCube Webmail';

// only list folders within this path
$rcmail_config['imap_root'] = '';

// store draft message is this mailbox
// leave blank if draft messages should not be stored
$rcmail_config['drafts_mbox'] = 'Drafts';

// store spam messages in this mailbox
$rcmail_config['junk_mbox'] = 'Junk';

// store sent message is this mailbox
// leave blank if sent messages should not be stored
$rcmail_config['sent_mbox'] = 'Sent';

// move messages to this folder when deleting them
// leave blank if they should be deleted directly
$rcmail_config['trash_mbox'] = 'Trash';

// display these folders separately in the mailbox list.
// these folders will automatically be created if they do not exist
$rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash');

// protect the default folders from renames, deletes, and subscription changes
$rcmail_config['protect_default_folders'] = TRUE;

// Set TRUE if deleted messages should not be displayed
// This will make the application run slower
$rcmail_config['skip_deleted'] = FALSE;

// Set true to Mark deleted messages as read as well as deleted
// False means that a message's read status is not affected by marking it as deleted
$rcmail_config['read_when_deleted'] = TRUE;

// When a Trash folder is not present and a message is deleted, flag
// the message for deletion rather than deleting it immediately. Setting this to
// false causes deleted messages to be permanantly removed if there is no Trash folder
$rcmail_config['flag_for_deletion'] = TRUE;

// Make use of the built-in spell checker. It is based on GoogieSpell.
// Since Google only accepts connections over https your PHP installatation
// requires to be compiled with Open SSL support
$rcmail_config['enable_spellcheck'] = TRUE;

// For a locally installed Nox Spell Server, please specify the URI to call it.
// Get Nox Spell Server from http://orangoo.com/labs/?page_id=72
// Leave empty to use the Google spell checking service, what means
// that the message content will be sent to Google in order to check spelling
$rcmail_config['spellcheck_uri'] = '';

// These languages can be selected for spell checking.
// Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch');
// Leave empty for default set of Google spell check languages
$rcmail_config['spellcheck_languages'] = NULL;

// path to a text file which will be added to each sent message
// paths are relative to the RoundCube root folder
$rcmail_config['generic_message_footer'] = '';

// this string is used as a delimiter for message headers when sending
// leave empty for auto-detection
$rcmail_config['mail_header_delimiter'] = NULL;

// in order to enable public ldap search, create a config array
// like the Verisign example below. if you would like to test,
// simply uncomment the Verisign example.
/**
 * example config for Verisign directory
 *
 * $rcmail_config['ldap_public']['Verisign'] = array(
 * 'name'     => 'Verisign.com',
 * 'hosts'     => array('directory.verisign.com'),
 * 'port'     => 389,
 * 'base_dn'    => '',
 * 'bind_dn'    => '',
 * 'bind_pass'   => '',
 * 'ldap_version' => 3,    // using LDAPv3
 * 'search_fields' => array('mail', 'cn'), // fields to search in
 * 'name_field'  => 'cn',  // this field represents the contact's name
 * 'email_field'  => 'mail', // this field represents the contact's e-mail
 * 'surname_field' => 'sn',  // this field represents the contact's last name
 * 'firstname_field' => 'gn', // this field represents the contact's first name
 * 'scope'     => 'sub',  // search mode: sub|base|list
 * 'filter'    => '',   // used for basic listing (if not empty) and will be &'d with search queries. ex: (status=act)
 * 'fuzzy_search' => true);  // server allows wildcard search
 */

// enable composing html formatted messages (experimental)
$rcmail_config['enable_htmleditor'] = FALSE;

// don't allow these settings to be overriden by the user
$rcmail_config['dont_override'] = array();

// list of configuration option names that need to be available in Javascript.
$rcmail_config['javascript_config'] = array('read_when_deleted', 'flag_for_deletion');

// try to load host-specific configuration
$rcmail_config['include_host_config'] = FALSE;


/***** these settings can be overwritten by user's preferences *****/

// show up to X items in list view
$rcmail_config['pagesize'] = 40;

// use this timezone to display date/time
$rcmail_config['timezone'] = intval(date('O'))/100 - date('I');

// is daylight saving On?
$rcmail_config['dst_active'] = (bool)date('I');

// prefer displaying HTML messages
$rcmail_config['prefer_html'] = TRUE;

// show pretty dates as standard
$rcmail_config['prettydate'] = TRUE;

// default sort col
$rcmail_config['message_sort_col'] = 'date';

// default sort order
$rcmail_config['message_sort_order'] = 'DESC';

// save compose message every 300 seconds (5min)
$rcmail_config['draft_autosave'] = 300;

// don't let users set pagesize to more than this value if set
$rcmail_config['max_pagesize'] = 200;

// end of config file
?>




Thanks in advance:ŞÃ‡

Offline exec

  • Newbie
  • *
  • Posts: 2
Re: Need help with config (main.inc.php)
« Reply #7 on: February 06, 2008, 11:31:58 AM »
Its terrible, I understand that my hosting firm is not supported IMAP what shall I do now???? :(

Offline jasonar

  • Jr. Member
  • **
  • Posts: 18
Re: Need help with config (main.inc.php)
« Reply #8 on: February 09, 2008, 10:50:18 AM »
Hi you shouldn't need to have IMAP on your server you just a POP3 access which ususally comes standard on hosting plans which include email. I Found a few things that need to be changed in your main.inc.php file:
Code: [Select]
Find this:

// automatically create a new RoundCube user when log-in the first time.
// a new user will be created once the IMAP login succeeds.
// set to false if only registered users can use this service
$rcmail_config['auto_create_user'] = FALSE;

Change to:

// automatically create a new RoundCube user when log-in the first time.
// a new user will be created once the IMAP login succeeds.
// set to false if only registered users can use this service
$rcmail_config['auto_create_user'] = TRUE;

Find this:

// the mail host chosen to perform the log-in
// leave blank to show a textbox at login, give a list of hosts
// to display a pulldown menu or set one host as string.
// To use SSL connection, enter ssl://hostname:993
$rcmail_config['default_host'] = 'mail.sultankoy.bel.tr';

Change it to:

// the mail host chosen to perform the log-in
// leave blank to show a textbox at login, give a list of hosts
// to display a pulldown menu or set one host as string.
// To use SSL connection, enter ssl://hostname:993
$rcmail_config['default_host'] = 'localhost';

try that and it should work, the the automatically create user, you want that otherwise it's not possible to login unless you manually create the user in the database for address book, settings, folders, etc. etc. so when you change to to true when the user logs in with a new email address it will create the user for you.

If you can any more question I'm here...

Offline syljms

  • Newbie
  • *
  • Posts: 5
Re: Need help with config (main.inc.php)
« Reply #9 on: April 03, 2008, 05:09:09 AM »
Hi Jasonar,

I appreciate your repeated assistance on this board.

I have a different problem. I installed rc2 with both db.inc and main.inc files set correctly.

When I visit the site, it throws out a blank page. Errors file says that fine DB.php not found.

Is DB.php part of installation files?

Sylvia