  File: config/README
  $Author: chuck $
  $Revision: 1.11 $
  $Date: 1998/12/17 21:39:12 $
  
  IMP: Copywrite 1998 Charles J. Hagenbuch chuck@horde.org
  
  You should have received a copy of the GNU Public
  License along with this package; if not, write to the
  Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  Boston, MA 02111-1307, USA.
  

--
Imp Defaults Configuration File

This is the documentation for the IMP defaults.php3 file.

The file itself is built around modifying the $default object that contains
sub objects for documents and user flags, options and other items.

There are examples configurations for several sites in the examples/
directory.


--
Html Configuration

To configure the html for any of the documents you will need to place values
in the ImpDocument class for it.

ImpDocument Class :

class ImpDocument {
   - Html Configuration Elements - 
   var $bg_file;                    - url to a background image -
   var $bg_color;                   - background color -
   var $text_color;                 - text color -
   var $link_color;                 - link color -
   var $vlink_color;                - vlink color -
   var $alink_color;                - alink color -
   - Rest of class is ommited for clarity see
   lib/imp.lib.php3 to see all of it -
   
   var $max_frm_chars;
       - the number of chars to chop the from: line at
         in mailbox pages -

   var $max_sub_chars;
       - the number of chars to chop the subject line at
         in mailbox pages -

Sample:
   Lets modify the main body pages background color to white :
   $default->body->bg_color = '#ffffff'; 


--
Server Specific Configuration

Since a lot of the configuration options are changing/being added, there
isn't as much documentation for them as there could be. Hopefully everytying
will be fully documented over time.

When changing the server specific configuration you address the
ImpDefault object directly. Here is the imp default object:

class ImpDefaults {
  - Local Configuration -
  var $localhost;
      - your local host name -

  
  - Html Configuration -
  var $cache_pages;
      - If true, then pages will be cached by the browser. This can result
        in some pages not updating when they should and security problems, but
        may speed things up for some, and makes debugging easier.
  
  - impmain frame colors -
  var $body;    
      - ImpDocument : configures the impmain frame colors - 
  
  - impmenu (sidebar) frame colors -
  var $sidebar;
      - ImpDocument : configures the impmenu frame colors -

  - URL Configuraton -
  var $graphics_url;
      - imp specfic graphics -

  var $root_url;
      - imp base url, this should *not* contain a server (ie,
      http://blah.foo.com), only the path (ie, /mail/imp/ or whatever). -
  
  
  - IMAP Configuration -
  var $server;
      - default IMAP server to connect to. Some people have reported troubl
        when using a numeric IP for this. If you get a "REG_BADRPT" error
	when trying to connect, try using the dns name of the machine instead. -
	
  var $from_server;
      - If a user is using the default server, and either does not have a
        custom from address, or user_change_from is false, then mail will be
	sent from $user@$from_server, instead of $server
	
	so for example if your imap server is mail.foo.com, but you want mail
	to appear to be sent from foo.com, set $from_server to 'foo.com'.
	
  var $folders;
      - default directory to look in for mail folders -
  var $sent_mail
      - default dir for sent messages -
  var $postponed
      - default dir for postponed messages -
  
  var $secure;
      - Use SSL for cookies if it is a secure connection -
  
  
  - Various external programs -
  var $path_to_sendmail
      - where to look for sendmail. if this is unset, then
        the php internal mail() function will be used. some
	installations of php using safe mode will require this
	fallback, or for sendmail to be in a safe_mofe approved
	directory -
  
  var $path_to_ispell
      - ispell can be used for rudimentary spell checking, if
        it is available -
  
  
  - Imp Server Configuration -
  var $user_change_server;
      - set false to force use of the default server -
  var $user_change_folder;
      - set false to force use of the default folder dir -
  var $user_change_from;
      - set false to force use of the system default from address -
  var $user_change_fullname;
      - set false to prevent user from setting their fullname -
      
  var $error_level;
      - the level to set error_reporting to. 1 is fairly silent,
        while 15 complains on just about everything (although warnings
	in error level 15 are considered low-priority bugs - do report
	them! i'd like it to run perfectly no matter what error level
	is set... -
  
  var $cookie_timeout;
      - time (in seconds) before IMP cookies expire -
  
  
  - Imp Client Configuration -
  var $max_messages_page;
      - max number of messages to display in one page in mailbox.php3 -
  
  
  - Imp v2 Database Configuration -
  var $v2_database;
      - true / false turn on / off the v2 database support.

  var $db_type;
      - The database type that you have chosen for your horde
         database. Select a option from the below list. -
      DB_MYSQL                * BETA            *
      DB_INFORMIX             * NOT IMPLEMENTED *
      DB_ORACLE               * NOT IMPLEMENTED *
      DB_POSTGRES             * NOT IMPLEMENTED *

  var $db_user_name;
      - The user name for the database you are connecting to. -

  var $db_password;
      - The password for the user you are connecting to. -

  var $db_name;
      - Database name you are connecting to. -
      
  var $db_server_name;
      - The server name you are connecting to ( defaults to localhost ) -
  var $db_connect_string;
      - Connection string, allows the user to override all of
        the connection variables with locale specifc/driver specific items
	
  var $db_persistent_mode;
      - If available within your driver, the object will try to be
        or not be in persistent mode. -


 ****************************************************************
                         W A R N I N G
 
 You MUST set $default->localhost to the name of the webserver.
 
 Cookies will be horribly broken otherwise.
 
 ****************************************************************


--
Below are some examples of custom code one might include at the bottom of a
defaults.php3, for various reasons:

/* set personal_folders to "INBOX." if we arre using Cyrus IMAP 
 *
 * Note: if you are using cyrus, only set this to something else
 *       you really know what it does..
 */ 
if ($default->cyrus->enabled) { $default->personal_folders = 'INBOX.'; }


--
MIME

Finally, the following line is required to include the mime configuration
file:

require( './config/mime.conf' );  /* Load the mime config file. */
