startPasswordReset method

Future<void> startPasswordReset(
  1. Session session, {
  2. required String email,
})

Requests a password reset for email.

If the email address is registered, an email with reset instructions will be send out. If the email is unknown, this method will have no effect.

Throws an EmailAccountPasswordResetRequestTooManyAttemptsException in case the client or account has been involved in too many reset attempts.

Implementation

Future<void> startPasswordReset(
  final Session session, {
  required final String email,
}) async {
  return AuthEmail.startPasswordReset(session, email: email);
}