auth_passwd.3

   1 '\" t
   2 .\"  <!-- Copyright 2004 Double Precision, Inc.  See COPYING for -->
   3 .\"  <!-- distribution information. -->
   4 .\"     Title: auth_passwd
   5 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   6 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
   7 .\"      Date: 06/20/2015
   8 .\"    Manual: Double Precision, Inc.
   9 .\"    Source: Double Precision, Inc.
  10 .\"  Language: English
  11 .\"
  12 .TH "AUTH_PASSWD" "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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  20 .ie \n(.g .ds Aq \(aq
  21 .el       .ds Aq '
  22 .\" -----------------------------------------------------------------
  23 .\" * set default formatting
  24 .\" -----------------------------------------------------------------
  25 .\" disable hyphenation
  26 .nh
  27 .\" disable justification (adjust text to left margin only)
  28 .ad l
  29 .\" -----------------------------------------------------------------
  30 .\" * MAIN CONTENT STARTS HERE *
  31 .\" -----------------------------------------------------------------
  32 .SH "NAME"
  33 auth_passwd \- Change account\*(Aqs password
  34 .SH "SYNOPSIS"
  35 .sp
  36 .nf
  37 #include <courierauth\&.h>
  38 .fi
  39 .HP \w'int\ rc=auth_passwd('u
  40 .BI "int rc=auth_passwd(const\ char\ *" "service" ", const\ char\ *" "username" ", const\ char\ *" "oldpassword" ", const\ char\ *" "newpassword" ");"
  41 .SH "DESCRIPTION"
  42 .PP
  43 If
  44 \fIusername\fR\*(Aqs password is
  45 \fIoldpassword\fR, it is replaced with
  46 \fInewpassword\fR\&.
  47 \fIservice\fR
  48 identifies which so\-called "service"\*(Aqs password is changed; like
  49 \(lqimap\(rq
  50 or
  51 \(lqpop3\(rq\&. Some Courier authentication library\*(Aqs back\-end module can use different passwords for different services\&.
  52 \fIservice\fR
  53 is ignored if this is not the case\&.
  54 .SH "RETURNS"
  55 .PP
  56 \fBauth_passwd\fR
  57 returns 0 if the password was succesfully changed\&. A non\-0 error code indicates a failure\&.\&.
  58 .SH "SEE ALSO"
  59 .PP
  60 \m[blue]\fB\fBauthlib\fR(3)\fR\m[]\&\s-2\u[1]\d\s+2,
  61 \m[blue]\fB\fBauth_generic\fR(3)\fR\m[]\&\s-2\u[2]\d\s+2,
  62 \m[blue]\fB\fBauth_login\fR(3)\fR\m[]\&\s-2\u[3]\d\s+2,
  63 \m[blue]\fB\fBauth_getuserinfo\fR(3)\fR\m[]\&\s-2\u[4]\d\s+2,
  64 \m[blue]\fB\fBauth_enumerate\fR(3)\fR\m[]\&\s-2\u[5]\d\s+2\&.
  65 .SH "NOTES"
  66 .IP " 1." 4
  67 \fBauthlib\fR(3)
  68 .RS 4
  69 \%http://www.courier-mta.org/authlib/authlib.html
  70 .RE
  71 .IP " 2." 4
  72 \fBauth_generic\fR(3)
  73 .RS 4
  74 \%http://www.courier-mta.org/authlib/auth_generic.html
  75 .RE
  76 .IP " 3." 4
  77 \fBauth_login\fR(3)
  78 .RS 4
  79 \%http://www.courier-mta.org/authlib/auth_login.html
  80 .RE
  81 .IP " 4." 4
  82 \fBauth_getuserinfo\fR(3)
  83 .RS 4
  84 \%http://www.courier-mta.org/authlib/auth_getuserinfo.html
  85 .RE
  86 .IP " 5." 4
  87 \fBauth_enumerate\fR(3)
  88 .RS 4
  89 \%http://www.courier-mta.org/authlib/auth_enumerate.html
  90 .RE