Import Upstream version 0.69.0

[hcoop/debian/courier-authlib.git] / authmysqlrc

diff --git a/authmysqlrc b/authmysqlrc
index c2640c5..567ce19 100644 (file)
--- a/authmysqlrc
+++ b/authmysqlrc
@@ -1,4 +1,4 @@
-##VERSION: $Id: authmysqlrc 17 2011-04-04 02:07:37Z mrsam $
+##VERSION: $Id: 01c3b327e4d5b8f4123500ce4c8d0ef7a690c10d-20160418083235$
 #
 # Copyright 2000-2007 Double Precision, Inc.  See COPYING for
 # distribution information.
@@ -78,7 +78,7 @@ MYSQL_DATABASE                mysql
 ##NAME: MYSQL_USER_TABLE:0
 #
 # The name of the table containing your user data.  See README.authmysqlrc
-# for the required fields in this table. 
+# for the required fields in this table.
 
 MYSQL_USER_TABLE       passwd
 
@@ -160,7 +160,7 @@ MYSQL_NAME_FIELD    name
 ##NAME: MYSQL_QUOTA_FIELD:0
 #
 # Define MYSQL_QUOTA_FIELD to be the name of the field that can optionally
-# specify a maildir quota.  See README.maildirquota for more information 
+# specify a maildir quota.  See README.maildirquota for more information
 #
 # MYSQL_QUOTA_FIELD    quota
 
@@ -192,7 +192,6 @@ MYSQL_NAME_FIELD    name
 
 ##NAME: MYSQL_SELECT_CLAUSE:0
 #
-# (EXPERIMENTAL)
 # This is optional, MYSQL_SELECT_CLAUSE can be set when you have a database,
 # which is structuraly different from proposed. The fixed string will
 # be used to do a SELECT operation on database, which should return fields
@@ -202,9 +201,6 @@ MYSQL_NAME_FIELD    name
 #
 # The username field should include the domain (see example below).
 #
-# Enabling this option causes ignorance of any other field-related
-# options, excluding default domain.
-#
 # There are two variables, which you can use. Substitution will be made
 # for them, so you can put entered username (local part) and domain name
 # in the right place of your query. These variables are:
@@ -220,6 +216,21 @@ MYSQL_NAME_FIELD   name
 # DEFAULTDELIVERY.  Courier mail server will also use esmtp when doing
 # authenticated ESMTP.
 #
+# Either cryptpw or clearpw are required. The other one can be specified
+# as an empty string; as well as maildir, quota, and option fields.
+#
+# Example:
+#
+# MYSQL_SELECT_CLAUSE   SELECT CONCAT(user,'@',domain), '', password, \
+#                              uid, gid, home, '' \
+#                       FROM users WHERE user='$(local_part)' \
+#                                    AND domain='$(domain)'
+#
+# The encrypted password field is not used, and a literal '', empty string,
+# appears in its place. Ditto for the 'maildir' field, and the remaining
+# optional fields are completely absent. The maildir field, in this example
+# can also be omitted, it's shown as an example only.
+#
 # This example is a little bit modified adaptation of vmail-sql
 # database scheme:
 #
@@ -286,3 +297,8 @@ MYSQL_NAME_FIELD    name
 #                      WHERE   local_part='$(local_part)'              \
 #                      AND     domain_name='$(domain)'
 #
+
+##NAME: MARKER:0
+#
+# Do not remove this section from this configuration file. This section
+# must be present at the end of this file.