Korzystanie z rozszerzenia E-mail z regułą

Rozszerzenie Trigger Email (firestore-send-email) umożliwia automatyczne wysyłanie e-maili na podstawie dokumentów w kolekcji Cloud Firestore. Dodanie dokumentu do kolekcji powoduje, że to rozszerzenie wysyła e-maila utworzonego na podstawie pól dokumentu. Pola najwyższego poziomu w dokumencie określają nadawcę i odbiorców e-maila, w tym opcje to, cc i bcc (każda z nich obsługuje identyfikatory UID). pole message dokumentu określa inne elementy e-maila, takie jak wiersz tematu i treść e-maila (w postaci zwykłego tekstu lub HTML).

Oto podstawowy przykładowy zapis dokumentu, który może wyzwolić to rozszerzenie:

admin.firestore().collection('mail').add({
  to: 'someone@example.com',
  message: {
    subject: 'Hello from Firebase!',
    html: 'This is an <code>HTML</code> email body.',
  },
})

Opcjonalnie możesz skonfigurować to rozszerzenie tak, aby renderowało e-maile za pomocą szablonów Handlebars.

Konfiguracja wstępna

Przed zainstalowaniem rozszerzenia wykonaj te czynności:

  1. Skonfiguruj usługę poczty wychodzącej.

    Podczas instalacji rozszerzenia Trigger Email musisz podać szczegóły połączenia i uwierzytelniania serwera SMTP, którego rozszerzenie używa do wysyłania e-maili. Ta opcja jest zwykle świadczona przez usługę dostarczania poczty e-mail takich jak Sendgrid, Mailgun czy Mailchimp Transactional Email, ale może możesz też używać samodzielnie uruchamianego serwera.

  2. Utwórz kolekcję dokumentów e-mail.

    Rozszerzenie Trigger Email wykrywa nowe dokumenty w określonej przez Ciebie kolekcji Cloud Firestore. Po znalezieniu nowego dokumentu rozszerzenie wysyła e-maila na podstawie pól dokumentu. Do tego celu możesz użyć dowolnej kolekcji Cloud Firestore. Przykłady na tej stronie korzystają z kolekcji o nazwie email.

  3. Skonfiguruj reguły bezpieczeństwa dla kolekcji dokumentów e-mail.

    To rozszerzenie może być używane do uruchamiania dostarczania poczty e-mail bezpośrednio z klienta aplikacji. Należy jednak dokładnie kontrolować dostęp klientów do kolekcji, aby uniknąć potencjalnego nadużycia (nie chcesz przecież, aby użytkownicy mogli wysyłać dowolne e-maile z adresu Twojej firmy).

    Reguły bezpieczeństwa różnią się w zależności od aplikacji, ale zawsze należy zadbać o to, aby e-maile były wysyłane tylko do odpowiednich odbiorców, a treści niestandardowe były ograniczone do minimum. Przydają się szablony: może za pomocą reguł zabezpieczeń sprawdzać, czy dane umieszczane w zgodnie z Twoimi oczekiwaniami dotyczącymi tego, co użytkownik może robić .

  4. Opcjonalnie: skonfiguruj kolekcję użytkowników.

    W ramach podstawowego korzystania z tego rozszerzenia określasz adresatów e-maila podając ich adresy e-mail w polach to, cc i bcc w dokument wiadomości. Jeśli natomiast masz bazę danych użytkowników w Cloud Firestore, możesz określić adresatów za pomocą atrybutu Identyfikatory UID. Do tego celu tak, kolekcja użytkowników musi spełniać te kryteria:

    • Kolekcja musi być oparta na identyfikatorach użytkowników. Oznacza to, że identyfikator dokumentu każdego dokumentu użytkownika w kolekcji musi być identyczny z identyfikatorem Firebase Authentication użytkownika.
    • Każdy dokument użytkownika musi zawierać pole email zawierające adres e-mail użytkownika adresu.

  5. Opcjonalnie: skonfiguruj kolekcję szablonów.

    Możesz renderować e-maile za pomocą szablonów paska sterowania. Aby to zrobić, potrzebujesz kolekcji Cloud Firestore zawierającej Twoje szablonów.

    Więcej informacji znajdziesz w artykule Korzystanie z szablonów Handlebars w rozszerzeniu Trigger Email.

Zainstaluj rozszerzenie

Aby zainstalować rozszerzenie, wykonaj czynności opisane na stronie Instalowanie rozszerzenia Firebase Extension. Podsumowując, wykonaj jedną z tych czynności:

Podczas instalacji rozszerzenia pojawi się prośba o podanie informacji o połączeniu SMTP oraz wcześniej skonfigurowanych kolekcji Cloud Firestore.

Korzystanie z rozszerzenia

Po instalacji to rozszerzenie monitoruje wszystkie zapisy dokumentów w skonfigurowanej kolekcji. Poczta e-mail jest dostarczana na podstawie zawartości pola dokumentu. Pola najwyższego poziomu określają nadawcę i odbiorców. Pole message zawiera informacje o wysyłanej wiadomości e-mail, w tym jej treść.

Przykład: Wyślij e-maila

Aby wysłać prostą wiadomość, dodaj dokument do swojej kolekcji wiadomości za pomocą to i message z taką zawartością:

to: ['someone@example.com'],
message: {
  subject: 'Hello from Firebase!',
  text: 'This is the plaintext section of the email body.',
  html: 'This is the <code>HTML</code> section of the email body.',
}

Pola nadawcy i adresata

Pola najwyższego poziomu w dokumencie zawierają informacje o nadawcy i odbiorcy e-maila. Dostępne pola:

  • from: adres e-mail nadawcy. Jeśli nie określono tego w dokumencie, używany jest skonfigurowany „Domyślny adres FROM” .
  • replyTo: zwrotny adres e-mail. Jeśli nie określono tego w dokumencie, używany jest skonfigurowany „Domyślny adres REPLY-TO” .
  • to: pojedynczy adres e-mail odbiorcy lub tablica zawierająca wiele adresów e-mail odbiorców.
  • toUids: tablica zawierająca identyfikatory UID odbiorców.
  • DW: pojedynczy adres e-mail odbiorcy lub tablica zawierająca wiele adresów e-mail odbiorców.
  • ccUids: tablica zawierająca identyfikatory UID adresatów w polu DW.
  • UDW: pojedynczy adres e-mail odbiorcy lub tablica zawierająca wiele adresów e-mail odbiorców.
  • bccUids: tablica zawierająca identyfikatory UID odbiorców w kopii UDW.
  • headers: obiekt dodatkowych pól nagłówka (na przykład {"X-Custom-Header": "value", "X-Second-Custom-Header": "value"}).

UWAGA: opcje toUids, ccUids i bccUids wysyłają e-maile na podstawie identyfikatorów użytkowników powiązanych z adresami e-mail w dokumencie Cloud Firestore. Aby korzystać z tych opcji odbiorców, musisz podać kolekcję Cloud Firestore dla parametru „Kolekcja użytkowników” rozszerzenia. Rozszerzenie może odczytać pole email dla każdego identyfikatora UID określonego w polach toUids, ccUids lub bccUids.

Pole wiadomości

Pole message w dokumencie zawiera nieprzetworzone informacje o dostawie e-maila. To pole powinno być wypełniane tylko przez zaufany kod działający na Twoich serwerach lub w Cloud Functions (patrz sekcja „Reguły bezpieczeństwa i wysyłanie e-maili” poniżej).

Dostępne właściwości pola message:

  • messageId:nagłówek identyfikatora e-maila, jeśli taki istnieje.
  • subject: temat e-maila.
  • text: zwykły tekst e-maila.
  • html: treść HTML e-maila.
  • amp: treść e-maila na AMP4EMAIL.
  • attachments: tablica zawierająca załączniki; Obsługiwane opcje Nodemailer: ciąg znaków utf-8, niestandardowy typ treści, URL, zakodowany ciąg znaków, identyfikator URI danych i wstępnie wygenerowany węzeł MIME (pamiętaj, że Twoja poczta e-mail nie ma dostępu do systemu plików serwera w chmurze).

Do wymagających zadań

Dowiedz się więcej o zaawansowanym korzystaniu z tego rozszerzenia: