generateEmailVerificationLink method

Future<String> generateEmailVerificationLink(
  1. String email, {
  2. ActionCodeSettings? actionCodeSettings,
})
inherited

Generates the out of band email action link to verify the user's ownership of the specified email. The ActionCodeSettings object provided as an argument to this method defines whether the link is to be handled by a mobile app or browser along with additional state information to be passed in the deep link, etc.

  • email - The email account to verify.
  • actionCodeSettings - The action code settings. If specified, the state/continue URL is set as the "continueUrl" parameter in the email verification link. The default email verification landing page will use this to display a link to go back to the app if it is installed. If the actionCodeSettings is not specified, no URL is appended to the action URL. The state URL provided must belong to a domain that is whitelisted by the developer in the console. Otherwise an error is thrown. Mobile app redirects are only applicable if the developer configures and accepts the Firebase Dynamic Links terms of service. The Android package name and iOS bundle ID are respected only if they are configured in the same Firebase Auth project.

Implementation

Future<String> generateEmailVerificationLink(
  String email, {
  ActionCodeSettings? actionCodeSettings,
}) {
  return _authRequestHandler.getEmailActionLink(
    'VERIFY_EMAIL',
    email,
    actionCodeSettings,
  );
}