docs/SQL_README

   1 SQL Autentication Settings
   2 -------------------------------
   3
   4 To configure MailZu to authenticate users against a PEAR compatible SQL
   5 database...
   6
   7   // Set an authentication method: 'ldap','ad', or 'sql'
   8   $conf['auth']['serverType'] = 'sql';
   9
  10 Set the type of database to authenticate to...
  11   /*** Database Authentication Settings ***/
  12   // Database type to be used by PEAR
  13   /* Options are:
  14         mysql  -> MySQL
  15         pgsql  -> PostgreSQL
  16         ibase  -> InterBase
  17         msql   -> Mini SQL
  18         mssql  -> Microsoft SQL Server
  19         oci8   -> Oracle 7/8/8i
  20         odbc   -> ODBC (Open Database Connectivity)
  21         sybase -> SyBase
  22         ifx    -> Informix
  23         fbsql  -> FrontBase
  24   */
  25   $conf['auth']['dbType'] = 'mysql';
  26
  27 Set the SQL host with optional port
  28
  29   // Database host specification (hostname[:port])
  30   $conf['auth']['dbHostSpec'] = 'dbhost';
  31
  32 Specify the credentials needed to access the database
  33
  34   // Database user who can access the auth database
  35   $conf['auth']['dbUser'] = 'user';
  36
  37   // Password for above user to auth database
  38   $conf['auth']['dbPass'] = 'pass';
  39
  40   // Name for auth database
  41   $conf['auth']['dbName'] = 'dbname';
  42
  43   // Name for auth table that contains usernames and passwords
  44   $conf['auth']['dbTable'] = 'dbtablename';
  45
  46   // Name of the 'first name' or 'full name' field of the SQL table
  47   // If such a field does not exist, leave it blank
  48   $conf['auth']['dbTableName'] = 'givennamefield';
  49
  50 Now we must set the login format.
  51
  52   // Name of the Username field of the SQL table
  53   $conf['auth']['dbTableUsername'] = 'usernamefield';
  54
  55 At the login page of MailZu, with this setting the user would use the value
  56 listed in the above field, which may or may not be the fully qualified email
  57 address.
  58
  59 Now we must set the field for the password.
  60
  61   // Name of the password field of the SQL table
  62   $conf['auth']['dbTablePassword'] = 'passwordfield';
  63
  64 Is the password stored in the database the MD5 digest?
  65
  66   // true   = passwords are stored md5 encrypted in database
  67   // false  = passwords are stored cleartext in database
  68   $conf['auth']['dbIsMd5'] = true;
  69
  70 These two attributes are enough to be authenticated to the MailZu interface,
  71 but the third attribute is what determines which messages the authenticated
  72 user is permitted to view. This attribute is the final recipient address. It is
  73 the email address that amavisd-new reports as the envelope recipient.
  74
  75 For example, if the login used was 'user', than there must be an attribute or
  76 field that determines the email address associated with this user. Even if the
  77 login was 'user@example.com' the third attribute may or may not be the same.
  78 The address might have been aliased to an internal address
  79 'user@internal.example.com'.
  80
  81   // Name of the 'mail address' field of the SQL table
  82   $conf['auth']['dbTableMail'] = 'mailaddress';