Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

Trigger Email

Firebase
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 認証情報を指定する必要があります。この拡張機能は、SendGrid や Mailgun などの一括メール配信サービス用です。

追加の設定

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

料金

拡張機能をインストールするには、プロジェクトを Blaze(従量課金制)プランに含める必要があります。

  • この拡張機能に必要な Firebase リソースに対して小額の料金(通常は約 $0.01/月)が請求されます(使用しなくても)。
  • この拡張機能は、次のような他の Firebase サービスや Google Cloud Platform サービスを使用します。このため、それらの無料枠を超えた場合には関連する料金が発生します。
  • Cloud Firestore
  • Cloud Functions(Node.js 10 を超えるランタイム。FAQ を参照)

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

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

Firebase コンソールの使用

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

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

Firebase CLI の使用

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

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

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

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

firebase ext:install firebase/firestore-send-email --project=projectId_or_alias
サポート対象
Cloud Firestore
作成者
ライセンス
Apache-2.0
バージョン
0.1.12