Author Topic: config file documentation  (Read 9713 times)

Offline xoqez

  • Jr. Member
  • **
  • Posts: 84
config file documentation
« on: July 02, 2006, 01:58:31 AM »
Hi,

I was wondering if there was a document outlinning what each of the options on the mail config file and some information on what options there are.

thanks

rob
--
Venond; using roundcube since June 2006
www.venond.com

Offline Prasad1337

  • Global Moderator
  • Full Member
  • *****
  • Posts: 114
Re: config file documentation
« Reply #1 on: July 02, 2006, 03:41:52 AM »
well there isnt a documentation exactly (to my knowledge) , but you can always ask about something your not sure of.

Offline xoqez

  • Jr. Member
  • **
  • Posts: 84
Re: config file documentation
« Reply #2 on: July 02, 2006, 04:22:41 AM »
currently i would like know some info about the anything highlighted in red from my config file

=================================================================

/*
 +-----------------------------------------------------------------------+
 | Main configuration file                        |
 |                                    |
 | This file is part of the RoundCube Webmail client           |
 | Copyright (C) 2005, 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'] = 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'] = 'mail.1550.co.nz';

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

// 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'] = '';

// 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'] = '';


// 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.1550.co.nz';

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

// 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'] = '';

// 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/';

// 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;

// 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';

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

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

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

// 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
$rcmail_config['default_imap_folders'] = array('INBOX', 'Drafts', 'Sent', 'Junk', 'Trash');

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

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

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

// 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
$rcmail_config['mail_header_delimiter'] = "\r\n";

// 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('hosts'     => array('directory.verisign.com'),
 *                          'port'     => 389,
 *                          'base_dn'    => '',
 *                          'search_fields' => array('Email' => 'mail', 'Name' => 'cn'),
 *                          'name_field'  => 'cn',
 *                          'mail_field'  => 'mail',
 *                          'scope'     => 'sub',
 *                          'fuzzy_search' => 0);
 */


/***** 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'] = 1;

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

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

// end of config file
?>
=================================================================
--
Venond; using roundcube since June 2006
www.venond.com

Offline flosoft

  • Sr. Member
  • ****
  • Posts: 349
    • http://flosoft.biz
Re: config file documentation
« Reply #3 on: July 02, 2006, 05:57:49 AM »
$rcmail_config['debug_level'] = 1;
That is simply the log level with 8 as maximum. To see what they change, just activate them.

$rcmail_config['default_host'] = 'mail.1550.co.nz';
If you leave this blank, you will be able to specify your host via a textbox on the loginscreen.

$rcmail_config['mail_domain'] = '';
If you use no default_host you are able to create a dropdown box with several servers.

$rcmail_config['virtuser_file'] = '';
$rcmail_config['virtuser_query'] = '';
The Virtuser file is for people whos logins are not easy to remember. For example web0p4 instead of the eMail. In that case you can setup a Virtuser File which translates the login web0p4 to an eMail Adress.
The Virtuser Query explains roundcube how to use your virtuser file.

Offline xoqez

  • Jr. Member
  • **
  • Posts: 84
Re: config file documentation
« Reply #4 on: July 02, 2006, 06:41:24 AM »
$rcmail_config['mail_domain'] = '';
If you use no default_host you are able to create a dropdown box with several servers.

last question(maybe):
how would i create this list? or what format would it be?
--
Venond; using roundcube since June 2006
www.venond.com

Offline flosoft

  • Sr. Member
  • ****
  • Posts: 349
    • http://flosoft.biz
Re: config file documentation
« Reply #5 on: July 02, 2006, 06:46:30 AM »
It would be with an array.

Offline Spaldo

  • Newbie
  • *
  • Posts: 1
Re: config file documentation
« Reply #6 on: July 11, 2006, 07:01:29 AM »
Quote from: flosoft
It would be with an array.

Since the other guy didn't post, I will post for him.

and that is ?

Offline xoqez

  • Jr. Member
  • **
  • Posts: 84
Re: config file documentation
« Reply #7 on: July 11, 2006, 08:33:35 PM »
I have not tried this yet as have not had time.

If should be something like.

'mail.domain1.com', 'mail.domain2.com', 'mail.domain3.com'

If you would like you can test it for me.

"I should disclose that I have not programmed in years; html is new when i was programming. I am work in telecomunications in ADSL technical and run a webhosting/design/extranet/ASP dev company. Todays programming tends to telling people what to do.  :P"
--
Venond; using roundcube since June 2006
www.venond.com

Offline bpat1434

  • Administrator
  • Hero Member
  • *****
  • Posts: 673
Re: config file documentation
« Reply #8 on: July 11, 2006, 11:51:56 PM »
I believe this may be of use:
PHP Arrays
 
  

Offline erasor

  • Newbie
  • *
  • Posts: 1
Re: config file documentation
« Reply #9 on: July 13, 2006, 12:09:19 PM »
I use sendmail as a mail server and implement the virtusertable file under /etc/mail.

should the 'virtuser_file' be '/etc/mail/virtusertable' or the hash file '/etc/mail/virtusertable.db'?

Could you give me an example of a standard 'virtuser_query' query script?

Offline Hippo

  • Newbie
  • *
  • Posts: 3
Re: config file documentation
« Reply #10 on: July 14, 2006, 09:30:09 AM »
can anyone please announce two words to the virtual-user behaviour?
Where the file should be placed? How should a query be structured?
I want to use this gorgeous function, but I'm unable to deal with it :(

@ pulldown menu:
Quote
// 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'] = array('imap.domain1.com','imap.domain2.de');

Offline bpat1434

  • Administrator
  • Hero Member
  • *****
  • Posts: 673
Re: config file documentation
« Reply #11 on: July 14, 2006, 09:42:54 AM »
The query should be structured as the comments say: returning the email address first.

The file can be placed anywhere you want, just make sure you put the proper path to it in the config file.
 
  

Offline Hippo

  • Newbie
  • *
  • Posts: 3
Re: config file documentation
« Reply #12 on: July 14, 2006, 10:12:56 AM »
Are the query and the file two different ways to resolve a login name with the email address?
Could you please give me an example file-content and query?

thx!

Offline bpat1434

  • Administrator
  • Hero Member
  • *****
  • Posts: 673
Re: config file documentation
« Reply #13 on: July 14, 2006, 10:18:56 PM »
The file, I'm not sure of....

The query is a query upon the users table of the Roundcube Database... something like:
Code: [Select]
SELECT email
FROM rc_users
WHERE alias LIKE '%$email%'
  OR email LIKE '%$email%'