搭配使用處理常式範本與觸發電子郵件擴充功能

如果您在擴充功能設定期間指定「範本集合」參數,就可以建立及管理用於電子郵件的Handlebars 範本

範本集合結構

為每份文件提供易記的 ID,並在寫入範本集合的文件中使用該 ID 做為範本名稱

範本文件可包含下列任一欄位:

  • subject: 電子郵件主旨的範本字串。
  • text:電子郵件明文內容的範本字串。
  • html:電子郵件 HTML 內容的範本字串。
  • amp:電子郵件中 AMP4EMAIL 內容的範本字串。
  • attachments:附件陣列,其中包含以範本字串做為值;支援的 Nodemailer 選項:utf-8 字串、自訂內容類型、網址、編碼字串、資料 URI 和預先產生的 MIME 節點 (請注意,您的電子郵件無法存取雲端伺服器的檔案系統)。

範例範本可能會有 ID 為 following,內容則可能如下:

{
  subject: "@{{username}} is now following you!",
  html: "Just writing to let you know that <code>@{{username}}</code> ({{name}}) is now following you.",
  attachments: [
    {
     filename: "{{username}}.jpg",
     path: "{{imagePath}}"
    }
  ]
}

使用範本傳送電子郵件

如要使用範本傳送電子郵件,請在郵件集合中新增文件時,加入含有 namedata 屬性的 template 欄位。例如,使用上述的 following 範本:

admin
  .firestore()
  .collection("MAIL_COLLECTION")
  .add({
    toUids: ["abc123"],
    template: {
      name: "following",
      data: {
        username: "ada",
        name: "Ada Lovelace",
        imagePath: "https://example.com/path/to/file/image-name.jpg"
      },
    },
  });

範本區段

您可以在範本文件中指定 {partial: true},使用可重複使用的部分來撰寫範本。每個標準資料欄位 (subjecthtmltextamp) 都會定義為僅在其自身環境中使用的部分。舉例來說,名為 footer 的部分可能會有以下資料:

{
  partial: true,
  html: "<p>This mail was sent by ExampleApp, Inc. <a href='https://example.com/unsubscribe'>Unsubscribe</a></p>",
  text: "This mail was sent by ExampleApp, Inc. Unsubscribe here: https://example.com/unsubscribe"
}

在另一個範本中,透過參照部分的名稱 (文件 ID) 來加入部分:

<p>This is my main template content, but it will use a common footer.</p>

{{> footer }}