X-Git-Url: http://git.hcoop.net/hcoop/debian/courier-authlib.git/blobdiff_plain/ac40fd9eb9d1980c90dc009d526a23ead1ec0f76..8d138742ae268344f406cb75d79aa6bf853f9d87:/auth_login.html diff --git a/auth_login.html b/auth_login.html index c4305f3..b3af3e5 100644 --- a/auth_login.html +++ b/auth_login.html @@ -1,19 +1,19 @@ -auth_login

Name

auth_login — Validate a userid and password

Synopsis


#include <courierauth.h>
-

int rc=auth_login(const char * service,
 const char * userid,
 const char * password,
 int  (*callback_func)(struct authinfo *, void *),
 void * callback_arg);

DESCRIPTION

+

int rc=auth_login(const char * service,
 const char * userid,
 const char * password,
 int  (*callback_func)(struct authinfo *, void *),
 void * callback_arg);

DESCRIPTION

auth_login verifies whether userid exists, and whether it's password is correct. service specifies which so-called "service" is being authenticated; like “imap” or “pop3”. service may or may not be used by the Courier -authentication library's configured back-end module.

RETURNS

+authentication library's configured back-end module.

RETURNS

callback_func will be invoked if auth_login succeeds, and callback_func's return value becomes @@ -26,7 +26,7 @@ return value indicates that this request was processed, but it failed.

The second argument to callback_func will be callback_arg, which is not interpreted by this function in any way. -The first argument will be a pointer to the following structure:

Example 1. struct authinfo

+The first argument will be a pointer to the following structure:
 
Example 1. struct authinfo
 struct authinfo {
 	const char *sysusername;
 	const uid_t *sysuserid;
@@ -79,7 +79,7 @@ The account's cleartext password, if available.
 If the account has an encrypted password defined, this field
 can be set to NULL.
options

 A comma-separated list of miscellaneous account options.
-See below for more information.
 
Account options

+See below for more information.
 
Account options

 Depending on the configuration of the Courier authentication library,
 accounts may have individual options associated with them.
 If the authentication library configuration does not implement account
@@ -123,15 +123,15 @@ account could possibly access (and that's on top of whatever else the
 access control lists say). See the virtual shared folder documentation
 for more information.

 For technical reasons, group names may not include comma, tab, "/" or "|"
-characters.
 
SEE ALSO

-authlib(3),
+characters.

SEE ALSO

+authlib(3), -auth_generic(3), +auth_generic(3), -auth_getuserinfo(3), +auth_getuserinfo(3), -auth_enumerate(3), +auth_enumerate(3), -auth_passwd(3), +auth_passwd(3), -auth_getoption(3).

+auth_getoption(3).