Generowanie linków działań dotyczących e-maili

Aplikacje mobilne muszą czasami wchodzić w interakcje z użytkownikami i nakazywać im określone działania poprzez wysyłanie e-maili.

Pakiety SDK klienta Firebase umożliwiają wysyłanie do użytkowników e-maili z linkami, za pomocą których mogą oni zresetować hasło, zweryfikować adres e-mail i logować się za pomocą adresu e-mail. Te oparte na szablonach e-maile są wysyłane przez Google i można je w ograniczonym zakresie dostosować.

Jeśli chcesz zamiast tego użyć własnych szablonów e-maili i usługi dostarczania poczty e-mail, na tej stronie dowiesz się, jak za pomocą pakietu SDK Firebase Admin automatycznie generować linki do działań dla powyższych procesów, które możesz umieszczać w e-mailach wysyłanych do użytkowników.

Dzięki temu:

  • Dostosowywanie szablonów e-maili. Obejmuje to możliwość dodawania nowych stylów i niestandardowych elementów marki, zmiany tekstu i logo, zwracania się do użytkowników po imieniu zamiast pełnego imienia i nazwiska itd.
  • Stosuj różne szablony w zależności od kontekstu. Jeśli na przykład użytkownik weryfikuje adres e-mail, aby zasubskrybować newsletter, w treści e-maila może być wymagany kontekst. Innym przykładem jest logowanie się za pomocą linku w e-mailu. W jednym scenariuszu może to być wywoływane przez tego samego użytkownika lub przez zaproszenie innego użytkownika. E-mail musi zawierać kontekst.
  • Lokalizowanie niestandardowych szablonów e-maili.
  • Możliwość wygenerowania linku z bezpiecznego środowiska serwera.
  • Możliwość dostosowania sposobu otwierania linku w aplikacji mobilnej lub przeglądarce oraz przekazywania dodatkowych informacji o stanie itp.
  • Możliwość dostosowania domeny linku dynamicznego używanej w aplikacji mobilnej podczas tworzenia linku do działania w e-mailu, a nawet określenia innej domeny linku dynamicznego w zależności od kontekstu lub aplikacji mobilnej.

Inicjowanie ustawień kodu akcji

Zanim będzie można wygenerować link do działania w e-mailu, może być konieczne zainicjowanie instancji ActionCodeSettings.

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

W przypadku linków, które mają być otwierane w aplikacji mobilnej, musisz włączyć Linki dynamiczne Firebase i wykonać pewne zadania, aby wykryć te linki w aplikacji mobilnej. Zapoznaj się z instrukcjami konfigurowania Linków dynamicznych Firebase, aby uzyskać działania w e-mailach.

Aby zainicjować instancję ActionCodeSettings, podaj te dane:

Parametr Typ Opis
url string,

Ustawia link (adres URL stanu/kontynuacji), który ma różne znaczenia w różnych kontekstach:

  • Gdy link jest obsługiwany w widżetach działań internetowych, jest to precyzyjny link w parametrze zapytania continueUrl.
  • Jeśli link jest obsługiwany bezpośrednio w aplikacji, jest to parametr zapytania continueUrl w precyzyjnym linku linku dynamicznego.
iOS ({bundleId: ciąg znaków}|niezdefiniowany) Ustawia identyfikator pakietu. Spowoduje to próbę otwarcia linku w aplikacji Apple, jeśli jest ona zainstalowana. Aplikacja musi być zarejestrowana w konsoli.
android ({packageName: string, installApp:boolean|undefined, minimumVersion: string|undefined}|undefined) Określa nazwę pakietu na Androida. Spowoduje to próbę otwarcia linku w zainstalowanej aplikacji na Androida. Jeśli właściwość installApp jest przekazana, określa, czy zainstalować aplikację na Androida, jeśli urządzenie ją obsługuje, a aplikacja nie jest jeszcze zainstalowana. Jeśli podasz to pole bez pola packageName, pojawi się błąd wyjaśniający, że w powiązaniu z tym polem należy podać packageName. Jeśli określisz minimumVersion i zainstalowana jest starsza wersja aplikacji, użytkownik zostanie przekierowany do Sklepu Play, aby ją uaktualnić. Aplikacja na Androida musi być zarejestrowana w Konsoli.
handleCodeInApp (wartość logiczna|niezdefiniowana) Określa, czy link do działania w e-mailu zostanie najpierw otwarty w aplikacji mobilnej, czy jako link internetowy. Wartość domyślna to false (fałsz). Jeśli zasada ma wartość Prawda, link z kodem działania jest wysyłany jako link uniwersalny lub link aplikacji na Androida i jest otwierany przez aplikację, jeśli jest zainstalowana. W przeciwnym razie kod zostanie najpierw wysłany do widżetu internetowego, a potem Dalej następuje przekierowanie do aplikacji, jeśli jest zainstalowana.
dynamicLinkDomain (ciąg|niezdefiniowany) Konfiguruje domenę (lub subdomenę) linku dynamicznego, która ma być używana w bieżącym połączeniu, jeśli ma ono być otwierane za pomocą Linków dynamicznych Firebase. W każdym projekcie można skonfigurować wiele domen linków dynamicznych, dlatego to pole umożliwia wybranie jednej z nich. Jeśli nie podasz żadnej, domyślnie zostanie użyta najstarsza domena.

Poniższy przykład pokazuje, jak wysłać e-mailowy link weryfikacyjny, który najpierw otworzy się w aplikacji mobilnej jako link dynamiczny Firebase (aplikacja Apple com.example.ios lub aplikacja na Androida com.example.android, którą zostanie zainstalowana, jeśli jeszcze nie jest zainstalowana, a minimalna wersja to 12). Precyzyjny link będzie zawierał ładunek adresu URL typu „Continue” – https://www.example.com/checkout?cartId=1234. Użyta domena linku dynamicznego to coolapp.page.link, którą należy skonfigurować na potrzeby Linków dynamicznych Firebase.

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 na ten temat znajdziesz w sekcji Informacje o stanie przekazywania w e-mailach.

Aby wygenerować link do resetowania hasła, podaj adres e-mail istniejącego użytkownika i opcjonalny obiekt ActionCodeSettings. Operacja zostanie zakończona wraz z linkiem do działania w e-mailu. Użyty 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żesz go wstawić do niestandardowego e-maila umożliwiającego zresetowanie hasła i wysłać go do odpowiedniego użytkownika przy użyciu niestandardowego serwera SMTP.

Jeśli nie korzystasz z domyślnej strony docelowej resetowania hasła i tworzysz własny niestandardowy moduł obsługi, przeczytaj artykuł o tworzeniu niestandardowych modułów obsługi działań związanych z pocztą e-mail.

Aby wygenerować link weryfikacyjny e-maila, podaj niezweryfikowany adres e-mail istniejącego użytkownika i opcjonalny obiekt ActionCodeSettings. Operacja zostanie zakończona po kliknięciu linku do działania w e-mailu. Użyty 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 linku możesz go wstawić do niestandardowego e-maila weryfikacyjnego i wysłać do odpowiedniego użytkownika przy użyciu niestandardowego serwera SMTP.

Jeśli nie używasz domyślnej strony docelowej weryfikacji adresu e-mail i tworzysz własny niestandardowy moduł obsługi, przeczytaj artykuł o tworzeniu niestandardowych modułów obsługi działań związanych z e-mailami.

Aby móc uwierzytelniać użytkowników za pomocą logowania się za pomocą linku e-mail, musisz włączyć logowanie się przy użyciu linku przez e-maila w projekcie Firebase.

Aby wygenerować link logowania, podaj adres e-mail użytkownika i obiekt ActionCodeSettings. Obiekt ActionCodeSettings jest w tym przypadku wymagany, aby podać informacje o tym, dokąd wrócić użytkownik po kliknięciu linku w celu zalogowania się. Operacja zostanie zakończona wraz z linkiem do działania e-maila.

W przeciwieństwie do resetowania hasła i weryfikacji adresu e-mail użyty adres e-mail nie musi należeć do istniejącego użytkownika, ponieważ za pomocą tej operacji można zarejestrować nowych użytkowników w aplikacji za pomocą linku w e-mailu.

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 używanego do logowania i wysłać go e-mailem do odpowiedniego użytkownika przy użyciu niestandardowego serwera SMTP.

Dowiedz się więcej o uwierzytelnianiem użytkowników w Firebase za pomocą linków e-mail. Pomoże to uzyskać informacje o tym, jak dokończyć logowanie, gdy użytkownik kliknie link i zostanie przekierowany z powrotem do aplikacji.