This HTML5 document contains 12 embedded RDF statements represented using HTML+Microdata notation.

The embedded RDF content will be recognized by any processor of HTML5 Microdata.

Subject Item

n2:email

rdf:type

schema:EntryPoint

schema:httpMethod

GET

schema:contentType

text/xml

n3:isWebServiceOf

n5:this_ODSUserModuleAPI

n3:endPointURL

n7:email

schema:shortDescription

<p>Send a password reminder email to an account owner. </p>

n3:hasParameter

n4:_pwdChangeUrl n4:_username n4:_email

schema:name

EntryPoint - user_password_recover_email

schema:description

<p>This method can be used to send a password reminder email to an account owner. The email will contain a link that can be used to change the password of the account in question.</p><p>ODS uses a template to create the password reminder emails. This template can contain a set of variables that will be replaced with the appropriate values:<itemizedlist> <listitem><p><computeroutput>%username%</computeroutput> - The user name of the account.</p></listitem><listitem><p><computeroutput>%fullname%</computeroutput> - The full name configured in the account, username as fallback.</p></listitem><listitem><p><computeroutput>%pwdchangeurl%</computeroutput> - The URL to the password changing page. This can be configured via <ref kindref="member" refid="group__ods__module__admin_1gadd8898e6ee5bf737acd77741115e9d61">admin.config.set()</ref> and config option <computeroutput>templates.urls.passwordChange</computeroutput> which is a template which contains two variables: <computeroutput>%sid%</computeroutput> and <computeroutput>%pin%</computeroutput> which are the session id and the password recovery PIN respectively. The latter can be used instead of the old password in <ref kindref="member" refid="group__ods__module__user_1ga454e9821088a774ba245ffcef0f16965">user.password.change()</ref>.</p></listitem></itemizedlist> </p><p>The template is stored in the Virtuoso DAV system and can easily be changed by uploading a new file and configuring its path to be the new password reminder email template via admin.config.set and config option <computeroutput>templates.emails.passwordReminder</computeroutput>.</p><p><parameterlist kind="param"><li> <parameternamelist> <parametername>username</parametername> </parameternamelist> <parameterdescription> <p>The account for which a password reminded should be sent. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>email</parametername> </parameternamelist> <parameterdescription> <p>Alternatively to the username the account email can be provided. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>pwdChangeUrl</parametername> </parameternamelist> <parameterdescription> <p>The password recovery page which should be used in the email. Only URLs on registered clients are allowed (see also <ref kindref="member" refid="group__ods__module__admin_1ga675af873f023acb812a8d7694a1d3b9f">admin.clients.new()</ref>). This parameter is a template which contains two variables: <computeroutput>%sid%</computeroutput> and <computeroutput>%pin%</computeroutput> which are the session id and the password recovery PIN respectively. The latter can be used instead of the old password in <ref kindref="member" refid="group__ods__module__user_1ga454e9821088a774ba245ffcef0f16965">user.password.change()</ref>.</p></parameterdescription> </li> </ul> <simplesect kind="see"><p><ref kindref="member" refid="group__ods__module__user_1ga454e9821088a774ba245ffcef0f16965">user.password.change()</ref></p></simplesect> <simplesect kind="par"><title>Authentication</title><p>This function does not require any authentication. </p></simplesect> </p>

schema:url

n7:email