AuthenticationHelper.ResetPassword Method

Resets password for user based on his request.

Namespace: CMS.Membership
Assembly: CMS.Membership (in CMS.Membership.dll) Version: 12.0.0

Syntax

public static string ResetPassword(
	string hash,
	string requestTime,
	int userID,
	double interval,
	string newPassword,
	string source,
	string sendEmailFrom,
	string siteName,
	MacroResolver resolver,
	out bool success,
	string invalidRequestText,
	string exceededTimeText
)

Parameters

hash

Type: System.String
Request hash (identifier).

requestTime

Type: System.String
Request time.

userID

Type: System.Int32
User id.

interval

Type: System.Double
Interval in which user can reset her password.

newPassword

Type: System.String
New password.

source

Type: System.String
Source of the request, used for logging.

sendEmailFrom

Type: System.String
Email address of the sender.

siteName

Type: System.String
Site name.

resolver

Type: CMS.MacroEngine.MacroResolver
Macro resolver used to resolve values in confirmation e-mail template.

success

Type: System.Boolean
Returns whether sending of request was successful.

invalidRequestText

Type: System.String
Text returned by this method if request is invalid.

exceededTimeText

Type: System.String
Text returned by this method if time request is exceeded.

Return Value

Type: String
Message with result description.

Remarks

In case the CMSSendPasswordResetConfirmation setting key is set to true, a confirmation email is sent to the user after successful password reset.