2 .\" <!-- Copyright 2004 Double Precision, Inc. See COPYING for -->
3 .\" <!-- distribution information. -->
4 .\" Title: auth_enumerate
5 .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
6 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
8 .\" Manual: Double Precision, Inc.
9 .\" Source: Double Precision, Inc.
12 .TH "AUTH_ENUMERATE" "3" "06/20/2015" "Double Precision, Inc." "Double Precision, Inc."
13 .\" -----------------------------------------------------------------
14 .\" * Define some portability stuff
15 .\" -----------------------------------------------------------------
16 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17 .\" http://bugs.debian.org/507673
18 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
19 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 .\" -----------------------------------------------------------------
23 .\" * set default formatting
24 .\" -----------------------------------------------------------------
25 .\" disable hyphenation
27 .\" disable justification (adjust text to left margin only)
29 .\" -----------------------------------------------------------------
30 .\" * MAIN CONTENT STARTS HERE *
31 .\" -----------------------------------------------------------------
33 auth_enumerate \- Obtain list of accounts
37 #include <courierauth\&.h>
39 .HP \w'auth_enumerate('u
40 .BI "auth_enumerate(int\ " "(*callback_func)" "\ (const\ char\ *,\ uid_t,\ gid_t,\ const\ char\ *,\ const\ char\ *,\ const\ char\ *,\ void\ *), void\ *" "callback_arg" ");"
44 enumerates all of the available accounts\&.
47 \fBcallback_func\fR, once for each account\&.
49 receives the following arguments:
70 Account\*(Aqs numeric userid\&.
81 Account\*(Aqs numeric groupid\&.
92 Account\*(Aqs home directory\&.
103 Account\*(Aqs mailbox (if defined, may be
104 NULL, which indicates the default mailbox location)\&.
115 Account\*(Aqs options string (if defined, may be
127 \fIcallback_arg\fR, verbatim\&.
132 for the last account,
136 one more time with all parameters set to
142 encounters an error it will terminate without calling
146 or 0 parameters\&. This can be used to determine whether a partial list of accounts was received\&.
152 .nr an-no-space-flag 1
160 Some back\-end Courier authentication modules do not implement account enumeration, so this function may not be available in all configurations\&.
165 \m[blue]\fB\fBauthlib\fR(3)\fR\m[]\&\s-2\u[1]\d\s+2,
166 \m[blue]\fB\fBauth_generic\fR(3)\fR\m[]\&\s-2\u[2]\d\s+2,
167 \m[blue]\fB\fBauth_login\fR(3)\fR\m[]\&\s-2\u[3]\d\s+2,
168 \m[blue]\fB\fBauth_getuserinfo\fR(3)\fR\m[]\&\s-2\u[4]\d\s+2,
169 \m[blue]\fB\fBauth_passwd\fR(3)\fR\m[]\&\s-2\u[5]\d\s+2\&.
174 \%http://www.courier-mta.org/authlib/authlib.html
177 \fBauth_generic\fR(3)
179 \%http://www.courier-mta.org/authlib/auth_generic.html
184 \%http://www.courier-mta.org/authlib/auth_login.html
187 \fBauth_getuserinfo\fR(3)
189 \%http://www.courier-mta.org/authlib/auth_getuserinfo.html
194 \%http://www.courier-mta.org/authlib/auth_passwd.html