GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  AUTH_ENUMERATE (3)

--> --> .ds Aq ’

NAME

auth_enumerate - Obtain list of accounts

CONTENTS

SYNOPSIS

#include <courierauth.h>

auth_enumerate(int (*callback_func) (const char *, uid_t, gid_t, const char *, const char *, const char *, void *), void *callback_arg);

DESCRIPTION

auth_enumerate enumerates all of the available accounts. auth_enumerate repeatedly calls callback_func, once for each account. callback_func receives the following arguments:

o

o Account name.

o

o Accounts numeric userid.

o

o Accounts numeric groupid.

o

o Accounts home directory.

o

o Accounts mailbox (if defined, may be NULL, which indicates the default mailbox location).

o

o Accounts options string (if defined, may be NULL)

o

o callback_arg, verbatim.

After invoking callback_func for the last account, auth_enumerate invokes callback_func one more time with all parameters set to NULL or 0.

If auth_enumerate encounters an error it will terminate without calling callback_func with all NULL or 0 parameters. This can be used to determine whether a partial list of accounts was received.

Note

Some back-end Courier authentication modules do not implement account enumeration, so this function may not be available in all configurations.

SEE ALSO

\m[blue]authlib(3)\m[][1], \m[blue]auth_generic(3)\m[][2], \m[blue]auth_login(3)\m[][3], \m[blue]auth_getuserinfo(3)\m[][4], \m[blue]auth_passwd(3)\m[][5].

NOTES

1. authlib(3)  http://www.courier-mta.org/authlib/authlib.html
2. auth_generic(3)  http://www.courier-mta.org/authlib/auth_generic.html
3. auth_login(3)  http://www.courier-mta.org/authlib/auth_login.html
4. auth_getuserinfo(3)  http://www.courier-mta.org/authlib/auth_getuserinfo.html
5. auth_passwd(3)  http://www.courier-mta.org/authlib/auth_passwd.html
Search for    or go to Top of page |  Section 3 |  Main Index


Double Precision, Inc. AUTH_ENUMERATE (3) 06/20/2015

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.