Generuję linki do czynności związanych z e-mailami

Aplikacje mobilne czasami muszą wchodzić w interakcję z użytkownikami i zachęcać ich do wykonywania określonych działań, wysyłając e-maile.

Pakiety SDK klienta Firebase umożliwiają wysyłanie użytkownikom e-maili z linkami, które mogą oni wykorzystać do resetowania hasła, weryfikacji adresu e-mail i logowania się za pomocą poczty e-mail. Te e-maile oparte na szablonach są wysyłane przez Google i mają ograniczone możliwości dostosowywania.

Jeśli chcesz zamiast tego używać własnych szablonów e-maili i własnej usługi dostarczania e-maili, na tej stronie znajdziesz informacje o tym, jak za pomocą pakietu Firebase Admin SDK generować programowo linki do działania w ramach powyższych procesów, które możesz dołączać do e-maili wysyłanych do użytkowników.

Dzięki temu:

  • Dostosowywanie szablonów e-maili. Obejmuje to możliwość dodawania nowych stylów i marki niestandardowej, zmieniania sformułowania i logo, zwracania się do użytkowników po imieniu zamiast po imieniu i nazisku itp.
  • stosować różne szablony w zależności od kontekstu; Jeśli na przykład użytkownik weryfikuje swój adres e-mail, aby zasubskrybować newsletter, w treści e-maila może być konieczne podanie kontekstu. Innym przykładem jest logowanie za pomocą linku e-mail: w jednym scenariuszu może być to wywołane przez tego samego użytkownika, a w drugim przez innego użytkownika. W e-mailu musisz podać kontekst.
  • Lokalizacja dostosowanych szablonów e-maili.
  • Możliwość generowania linku z bezpiecznego środowiska serwera.
  • możliwość dostosowania sposobu otwierania linku (za pomocą aplikacji mobilnej lub przeglądarki) oraz sposobu przekazywania dodatkowych informacji o stanie;
  • Możliwość dostosowywania domeny linku mobilnego używanego w przypadku procesów aplikacji mobilnej podczas tworzenia linku akcji e-mail.

Inicjowanie ActionCodeSettings

Zanim wygenerujesz link działania e-mail, konieczne może być zainicjowanie instancji ActionCodeSettings.

ActionCodeSettings umożliwiają przekazanie dodatkowych informacji za pomocą adresu URL kontynuacji, który jest dostępny po kliknięciu przez użytkownika linku w e-mailu. Dzięki temu użytkownik może też wrócić do aplikacji po wykonaniu działania. Dodatkowo możesz określić, czy link do działania w e-mailu ma być obsługiwany bezpośrednio w aplikacji mobilnej po jej zainstalowaniu czy w przeglądarce.

W przypadku linków, które mają być otwierane w aplikacji mobilnej, musisz wykonać pewne czynności, aby wykrywać te linki w aplikacji mobilnej. Zapoznaj się z instrukcjami konfigurowania linków mobilnych w przypadku działań e-mail.

Aby zainicjować instancję ActionCodeSettings, podaj te dane:

Parametr Typ Opis
url ciąg znaków

Ustawia link (URL stanu lub kontynuacji), który ma różne znaczenia w zależności od kontekstu:

  • Gdy link jest obsługiwany w widżetach działań w przeglądarce, jest to precyzyjny link w parametrze zapytania continueUrl.
  • Gdy link jest obsługiwany bezpośrednio w aplikacji, jest to parametr zapytania continueUrl w precyzyjnym linku Hosting.
iOS ({bundleId: string}|undefined) Ustawia identyfikator pakietu iOS, aby pomóc Firebase Authentication określić, czy ma utworzyć link tylko do wersji internetowej czy do wersji mobilnej, który będzie otwierany na urządzeniu Apple.
android ({packageName: string, installApp:boolean|undefined, minimumVersion: string|undefined}|undefined) Ustawia nazwę pakietu Androida, aby pomóc aplikacji Firebase Authentication określić, czy ma utworzyć link tylko do wersji internetowej czy do wersji mobilnej, który będzie otwierany na urządzeniu z Androidem.
handleCodeInApp (wartość logiczna|nieokreślona) Określ, czy link do działania w e-mailu ma się najpierw otworzyć w aplikacji mobilnej, czy w przeglądarce. Wartość domyślna to fałsz. Jeśli ta opcja ma wartość Prawda, link do kodu działania będzie wysyłany jako uniwersalny link lub link aplikacji na Androida i będzie otwierany przez aplikację, jeśli jest zainstalowana. W przypadku fałszywego wyniku kod zostanie wysłany najpierw do widżetu internetowego, a potem przekieruje do aplikacji, jeśli jest zainstalowana.
linkDomain (string|undefined) Jeśli w przypadku projektu zdefiniowano niestandardowe domeny linków hostingu, określ, której z nich chcesz używać, gdy link ma być otwierany przez określoną aplikację mobilną. W przeciwnym razie domyślnie zostanie wybrana domena domyślna (np. PROJECT_ID.firebaseapp.com).
dynamicLinkDomain (string|undefined) Rola wycofana. Nie podawaj tego parametru.

Ten przykład pokazuje, jak wysłać e-maila z linkiem weryfikacyjnym, który najpierw otworzy się w aplikacji mobilnej. Precyzyjny link będzie zawierać URL kontynuacji https://www.example.com/checkout?cartId=1234. Używana niestandardowa domena Hostinglinku to custom-domain.com, która musi być skonfigurowana do użycia z Firebase Hosting.

Node.js

const actionCodeSettings = {
  // URL you want to redirect back to. The domain (www.example.com) for
  // this URL must be whitelisted in the Firebase Console.
  url: 'https://www.example.com/checkout?cartId=1234',
  // This must be true for email link sign-in.
  handleCodeInApp: true,
  iOS: {
    bundleId: 'com.example.ios',
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12',
  },
  // FDL custom domain.
  dynamicLinkDomain: 'coolapp.page.link',
};

Java

ActionCodeSettings actionCodeSettings = ActionCodeSettings.builder()
    .setUrl("https://www.example.com/checkout?cartId=1234")
    .setHandleCodeInApp(true)
    .setIosBundleId("com.example.ios")
    .setAndroidPackageName("com.example.android")
    .setAndroidInstallApp(true)
    .setAndroidMinimumVersion("12")
    .setDynamicLinkDomain("coolapp.page.link")
    .build();

Python

action_code_settings = auth.ActionCodeSettings(
    url='https://www.example.com/checkout?cartId=1234',
    handle_code_in_app=True,
    ios_bundle_id='com.example.ios',
    android_package_name='com.example.android',
    android_install_app=True,
    android_minimum_version='12',
    dynamic_link_domain='coolapp.page.link',
)

Go

actionCodeSettings := &auth.ActionCodeSettings{
	URL:                   "https://www.example.com/checkout?cartId=1234",
	HandleCodeInApp:       true,
	IOSBundleID:           "com.example.ios",
	AndroidPackageName:    "com.example.android",
	AndroidInstallApp:     true,
	AndroidMinimumVersion: "12",
	DynamicLinkDomain:     "coolapp.page.link",
}

C#

var actionCodeSettings = new ActionCodeSettings()
{
    Url = "https://www.example.com/checkout?cartId=1234",
    HandleCodeInApp = true,
    IosBundleId = "com.example.ios",
    AndroidPackageName = "com.example.android",
    AndroidInstallApp = true,
    AndroidMinimumVersion = "12",
    DynamicLinkDomain = "coolapp.page.link",
};

Więcej informacji znajdziesz w artykule Przekazywanie stanu w działaniach e-maila.

Generowanie linku do resetowania hasła w e-mailu

Aby wygenerować link do resetowania hasła, podaj adres e-mail istniejącego użytkownika i opcjonalnie obiekt ActionCodeSettings. Operacja zostanie rozwiązana za pomocą linku do działania w e-mailu. Adres e-mail musi należeć do istniejącego użytkownika.

Node.js

// Admin SDK API to generate the password reset link.
const userEmail = 'user@example.com';
getAuth()
  .generatePasswordResetLink(userEmail, actionCodeSettings)
  .then((link) => {
    // Construct password reset email template, embed the link and send
    // using custom SMTP server.
    return sendCustomPasswordResetEmail(userEmail, displayName, link);
  })
  .catch((error) => {
    // Some error occurred.
  });

Java

String email = "user@example.com";
try {
  String link = FirebaseAuth.getInstance().generatePasswordResetLink(
      email, actionCodeSettings);
  // Construct email verification template, embed the link and send
  // using custom SMTP server.
  sendCustomEmail(email, displayName, link);
} catch (FirebaseAuthException e) {
  System.out.println("Error generating email link: " + e.getMessage());
}

Python

email = 'user@example.com'
link = auth.generate_password_reset_link(email, action_code_settings)
# Construct password reset email from a template embedding the link, and send
# using a custom SMTP server.
send_custom_email(email, link)

Go

email := "user@example.com"
link, err := client.PasswordResetLinkWithSettings(ctx, email, actionCodeSettings)
if err != nil {
	log.Fatalf("error generating email link: %v\n", err)
}

// Construct password reset template, embed the link and send
// using custom SMTP server.
sendCustomEmail(email, displayName, link)

C#

var email = "user@example.com";
var link = await FirebaseAuth.DefaultInstance.GeneratePasswordResetLinkAsync(
    email, actionCodeSettings);
// Construct email verification template, embed the link and send
// using custom SMTP server.
SendCustomEmail(email, displayName, link);

Po wygenerowaniu linku można go umieścić w niestandardowym e-mailu z resetem hasła, a potem wysłać e-maila do odpowiedniego użytkownika za pomocą niestandardowego serwera SMTP.

Jeśli nie używasz domyślnej strony docelowej resetowania hasła i tworzysz własny moduł obsługi, zapoznaj się z artykułem Tworzenie niestandardowych modułów obsługi działań e-mail.

Generowanie linku weryfikacyjnego e-maila

Aby wygenerować link weryfikacyjny e-maila, podaj niezweryfikowany adres e-mail istniejącego użytkownika i opcjonalnie obiekt ActionCodeSettings. Operacja zostanie rozwiązana za pomocą linku działania e-maila. Używany adres e-mail musi należeć do istniejącego użytkownika.

Node.js

// Admin SDK API to generate the email verification link.
const useremail = 'user@example.com';
getAuth()
  .generateEmailVerificationLink(useremail, actionCodeSettings)
  .then((link) => {
    // Construct email verification template, embed the link and send
    // using custom SMTP server.
    return sendCustomVerificationEmail(useremail, displayName, link);
  })
  .catch((error) => {
    // Some error occurred.
  });

Java

String email = "user@example.com";
try {
  String link = FirebaseAuth.getInstance().generateEmailVerificationLink(
      email, actionCodeSettings);
  // Construct email verification template, embed the link and send
  // using custom SMTP server.
  sendCustomEmail(email, displayName, link);
} catch (FirebaseAuthException e) {
  System.out.println("Error generating email link: " + e.getMessage());
}

Python

email = 'user@example.com'
link = auth.generate_email_verification_link(email, action_code_settings)
# Construct email from a template embedding the link, and send
# using a custom SMTP server.
send_custom_email(email, link)

Go

email := "user@example.com"
link, err := client.EmailVerificationLinkWithSettings(ctx, email, actionCodeSettings)
if err != nil {
	log.Fatalf("error generating email link: %v\n", err)
}

// Construct email verification template, embed the link and send
// using custom SMTP server.
sendCustomEmail(email, displayName, link)

C#

var email = "user@example.com";
var link = await FirebaseAuth.DefaultInstance.GenerateEmailVerificationLinkAsync(
    email, actionCodeSettings);
// Construct email verification template, embed the link and send
// using custom SMTP server.
SendCustomEmail(email, displayName, link);

Po wygenerowaniu link można go wstawić do niestandardowego e-maila weryfikacyjnego, a następnie wysłać do odpowiedniego użytkownika za pomocą niestandardowego serwera SMTP.

Jeśli nie używasz domyślnej strony docelowej weryfikacji e-maila i tworzysz własny moduł obsługi, zapoznaj się z artykułem Tworzenie niestandardowych modułów obsługi działań e-mail.

Generowanie linku e-mail do logowania

Zanim zaczniesz uwierzytelniać użytkowników za pomocą logowania się za pomocą linku e-mail, musisz włączyć logowanie za pomocą linku e-mail w projekcie Firebase.

Aby wygenerować link do logowania, podaj adres e-mail użytkownika i obiekt ActionCodeSettings. W tym przypadku obiekt ActionCodeSettings jest wymagany, aby podać informacje o tym, dokąd ma wrócić użytkownik po kliknięciu linku do strony logowania. Operacja zostanie rozwiązana za pomocą linku działania e-maila.

W odróżnieniu od resetowania hasła i weryfikacji adresu e-mail adres e-mail użyty do tej operacji nie musi należeć do obecnego użytkownika, ponieważ można go użyć do rejestracji nowych użytkowników w aplikacji za pomocą linku e-mail.

Node.js

// Admin SDK API to generate the sign in with email link.
const useremail = 'user@example.com';
getAuth()
  .generateSignInWithEmailLink(useremail, actionCodeSettings)
  .then((link) => {
    // Construct sign-in with email link template, embed the link and
    // send using custom SMTP server.
    return sendSignInEmail(useremail, displayName, link);
  })
  .catch((error) => {
    // Some error occurred.
  });

Java

String email = "user@example.com";
try {
  String link = FirebaseAuth.getInstance().generateSignInWithEmailLink(
      email, actionCodeSettings);
  // Construct email verification template, embed the link and send
  // using custom SMTP server.
  sendCustomEmail(email, displayName, link);
} catch (FirebaseAuthException e) {
  System.out.println("Error generating email link: " + e.getMessage());
}

Python

email = 'user@example.com'
link = auth.generate_sign_in_with_email_link(email, action_code_settings)
# Construct email from a template embedding the link, and send
# using a custom SMTP server.
send_custom_email(email, link)

Go

email := "user@example.com"
link, err := client.EmailSignInLink(ctx, email, actionCodeSettings)
if err != nil {
	log.Fatalf("error generating email link: %v\n", err)
}

// Construct sign-in with email link template, embed the link and send
// using custom SMTP server.
sendCustomEmail(email, displayName, link)

C#

var email = "user@example.com";
var link = await FirebaseAuth.DefaultInstance.GenerateSignInWithEmailLinkAsync(
    email, actionCodeSettings);
// Construct email verification template, embed the link and send
// using custom SMTP server.
SendCustomEmail(email, displayName, link);

Po wygenerowaniu linku możesz go wstawić do niestandardowego e-maila z zaproszeniem do zalogowania się, a potem wysłać go do odpowiedniego użytkownika za pomocą niestandardowego serwera SMTP.

Dowiedz się więcej o uwierzytelnianiu użytkowników za pomocą Firebase przy użyciu linków e-mail. Dzięki temu możesz podać informacje o tym, jak dokończyć logowanie, gdy użytkownik kliknie link i zostanie przekierowany z powrotem do aplikacji.