mhX_password_update(3xmh) — Subroutines

Name

mhX_password_update − Updates the password in a specified user’s O/R address entry in the MAILbus 400 MTA’s routing information.

Syntax

OM_return_code = mhX_password_update(session, user_address, current_password, new_password, diagnostic)

Argument	Data Type	Access
session	OM_private_object	Read
user_address	OM_public_object	Read
current_password	OM_string	Read
new_password	OM_string	Read
diagnostic	OM_enumeration	Write

C Binding

OM_return_code mhX_password_update(session, user_address, current_password, new_password, diagnostic) OM_private_object session;
OM_public_object user_address;
OM_string current_password;
OM_string new_password;
OM_enumeration ∗diagnostic;

Arguments

SessionA session previously established between Client and Service.

User AddressExplicitly identifies the user whose password is about to be updated; an instance of the OR Address class.

Current PasswordThe password currently associated with the O/R address. A descriptor with a length of zero (0) indicates a null password.

New PasswordThe new password to be associated with the user address.

DiagnosticIf the return code is MH_RC_ORIGINATOR_IMPROPER, this diagnostic further describes the condition.

Description

Checks that the Current Password argument matches the password in the directory entry for the O/R address specified in the User Address argument. If this check fails, the routine returns the error MH_RC_ORIGINATOR_IMPROPER, with the diagnostic MHX_PWDU_PWD_MISMATCH.

If the value supplied as the New Password argument is not valid within the constraints defined by the MTS, the routine returns the error MH_RC_ORIGINATOR_IMPROPER, with the diagnostic MHX_PWDU_INVALID_PASSWORD.

The password in the O/R address entry in the directory is updated with the pass word supplied in the New Password argument. If the update is successful then the routine returns OM_SUCCESS.

A return code of OM_SYSTEM_ERROR indicates a problem with the directory that might be temporary. The Client should try again.

Note that all arguments are mandatory.

Return Values

OM_MEMORY_INSUFFICIENT

OM_NETWORK_ERROR

MH_RC_NO_SUCH_USER

MH_RC_ORIGINATOR_IMPROPER

OM_SYSTEM_ERROR

MH_RC_WRONG_CLASS

OM_SUCCESS

Plus errors returned from:

om_create

om_put

Examples

    om_status = mhX_password_update ( session,
                                      address,
                                      secret,
                                      new_secret,
                                      &diagnostic );

Museum