release

[hcoop/debian/courier-authlib.git] / auth_passwd.3

.\"  <!-- $Id: auth_passwd.sgml,v 1.3 2007/04/01 00:21:34 mrsam Exp $ -->
.\"  <!-- Copyright 2004 Double Precision, Inc.  See COPYING for -->
.\"  <!-- distribution information. -->
.\"     Title: auth_passwd
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\"      Date: 08/23/2008
.\"    Manual: Double Precision, Inc.
.\"    Source: Double Precision, Inc.
.\"
.TH "AUTH_PASSWD" "3" "08/23/2008" "Double Precision, Inc." "Double Precision, Inc."
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
auth_passwd - Change account's password
.SH "SYNOPSIS"
.sp
.RS 4
.nf
#include <courierauth\.h>
.fi
.RE
.HP 19
.BI "int rc=auth_passwd(const\ char\ *" "service" ", const\ char\ *" "username" ", const\ char\ *" "oldpassword" ", const\ char\ *" "newpassword" ");"
.SH "DESCRIPTION"
.PP
If
\fIusername\fR\'s password is
\fIoldpassword\fR, it is replaced with
\fInewpassword\fR\.
\fIservice\fR
identifies which so\-called "service"\'s password is changed; like
\(lqimap\(rq
or
\(lqpop3\(rq\. Some Courier authentication library\'s back\-end module can use different passwords for different services\.
\fIservice\fR
is ignored if this is not the case\.
.SH "RETURNS"
.PP

\fBauth_passwd\fR
returns 0 if the password was succesfully changed\. A non\-0 error code indicates a failure\.\.
.SH "SEE ALSO"
.PP

\fI\fBauthlib\fR(3)\fR\&[1],
\fI\fBauth_generic\fR(3)\fR\&[2],
\fI\fBauth_login\fR(3)\fR\&[3],
\fI\fBauth_getuserinfo\fR(3)\fR\&[4],
\fI\fBauth_enumerate\fR(3)\fR\&[5]\.
.SH "NOTES"
.IP " 1." 4
\fBauthlib\fR(3)
.RS 4
\%authlib.html
.RE
.IP " 2." 4
\fBauth_generic\fR(3)
.RS 4
\%auth_generic.html
.RE
.IP " 3." 4
\fBauth_login\fR(3)
.RS 4
\%auth_login.html
.RE
.IP " 4." 4
\fBauth_getuserinfo\fR(3)
.RS 4
\%auth_getuserinfo.html
.RE
.IP " 5." 4
\fBauth_enumerate\fR(3)
.RS 4
\%auth_enumerate.html
.RE