Trigger Email

Firebase
Made by Firebase

指定した Cloud Firestore コレクションに書き込まれたドキュメントのコンテンツに基づいて、メールを生成し送信します。

この拡張機能の動作

この拡張機能を使用すると、指定した Cloud Firestore コレクションに追加されたドキュメントから情報を抽出してメールを生成し、送信できます。

ドキュメントを追加することによってこの拡張機能がトリガーされ、ドキュメントのフィールドの情報に基づいてメールが生成、送信されます。ドキュメントの最上位の各フィールドには、メールの送信者と受信者が指定されています(受信者には toccbcc の項目があり、どれも UID をサポートしています)。ドキュメントの message フィールドには、件名やメール本文(平文または HTML)などのメール要素が指定されています。

この拡張機能が呼び出される基本的なドキュメント書き込みの例は次のとおりです。

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

この拡張機能はオプションで、Handlebar テンプレートを使用してメールを表示するように構成することもできます。各テンプレートは、Cloud Firestore コレクションに保存されているドキュメントです。

この拡張機能を構成するときは、メール配信用の SMTP 認証情報を指定する必要があります。

追加の設定

インストール前に、必ず Firebase プロジェクトで Cloud Firestore データベースを設定してください。

Billing

この拡張機能は、次のような他の Firebase サービスや Google Cloud Platform サービスを使用するため、それらに関連する料金が発生する可能性があります。

  • Cloud Firestore
  • Cloud Functions

Firebase Extensions を使用する場合、課金の対象になるのは使用した基盤リソースのみです。有料階層の料金プランは、拡張機能が有料階層プランの必要なサービス(例: Google Cloud Platform API の呼び出しや、Google 以外のサービスに対する送信ネットワーク リクエストを行うサービス)を利用する場合のみ必要となります。なお、すべての Firebase サービスに無料使用枠が用意されています。詳しくは、Firebase の料金についての記事をご覧ください。

この拡張機能を使用するには、メール配信用の SMTP 認証情報も必要になります。SMTP プロバイダの利用に関連する費用については、すべてお客様の負担となります。

この拡張機能をインストールする方法

Firebase コンソールの使用

拡張機能のインストールと管理は、Firebase コンソールで行えます。

コンソールを使用してインストールする

Firebase CLI の使用

拡張機能のインストールと管理は、Firebase CLI でも行えます。

ステップ 1: 以下の npm コマンドを実行して、CLI をインストールするか、最新バージョンの CLI に更新します。

npm install -g firebase-tools
正常に機能しない場合は、Firebase CLI リファレンスを確認するか、npm のアクセス権を変更してください。

ステップ 2: 以下のコマンドを実行して、この拡張機能をインストールします。

firebase ext:install firestore-send-email --project=projectId_or_alias

Blaze プランへの加入が必要です

サポート対象
Cloud Firestore
作成者
ライセンス
Apache-2.0
バージョン
0.1.4