程式設計層級：入門
時間長度：10 分鐘
專案類型：透過自訂選單執行自動化動作
目標
- 瞭解解決方案的功能。
- 瞭解 Apps Script 服務在
解決方案
- 設定指令碼。
- 執行指令碼。
認識這項解決方案
在電子郵件範本中自動填入 Google 試算表的資料。
電子郵件會從您的 Gmail 帳戶傳送，方便您回覆
位收件者回覆。
重要事項：這個郵件合併樣本受到上述電子郵件限制的規範
Google 服務的配額一文。
運作方式
您建立了 Gmail 草稿範本，其中預留位置含有下列預留位置：
對應至試算表中的資料各欄標題
工作表中代表預留位置標記指令碼會傳送
試算表中每個預留位置都會對應到
預留位置標記。
Apps Script 服務
這項解決方案使用下列服務：
必要條件
如要使用這個範例，您必須具備下列先決條件：
- Google 帳戶 (Google Workspace 帳戶可能會
需要管理員核准)。
- 可存取網際網路的網路瀏覽器。
設定指令碼
建立 Apps Script 專案
- 請點選下方按鈕來複製
Gmail/試算表郵件合併範例試算表。
這項操作的 Apps Script 專案
解決方案附加在試算表上
建立副本
- 在複製的試算表中，將「收件者」欄更新為電子郵件地址
指定要在郵件合併中使用的地址。
- (選用) 新增、編輯或移除資料欄，自訂所需資料
加入電子郵件範本
如果您變更了收件者或電子郵件
Sent (傳送) 欄中，您必須更新
Apps Script 專案。您可以開啟 Apps Script
「透過試算表建立專案」
按一下「擴充功能」圖示 >
Apps Script。
建立電子郵件範本
- 在 Gmail 帳戶中建立電子郵件草稿。納入資料
從
在電子郵件中使用與欄名稱對應的預留位置
由大括號括住，例如
{{First name}}。
- 如果您要設定電子郵件中的文字格式，就必須同時設定預留位置格式
方括號。
- 預留位置區分大小寫，且必須與欄標題完全相符。
- 複製電子郵件草稿的主旨行。
執行指令碼
- 在試算表中按一下「郵件合併」圖示 >。
傳送電子郵件。你可能需要重新整理這個自訂選單的頁面
。
出現提示時，請授權指令碼。
如果 OAuth 同意畫面顯示「這個應用程式未經驗證」警告，
如要繼續，請選取「進階」圖示 >
前往 {Project Name} (不安全)。
依序按一下「郵件合併」>「傳送電子郵件」。
可以選取「重新建立」，再次生成新的提示
貼上電子郵件範本的主旨行，然後按一下「確定」。
如果你在工作表中套用篩選器，指令碼仍會透過電子郵件傳送篩選後的電子郵件
但不會加入時間戳記
查看程式碼
如要查看這個解決方案的 Apps Script 程式碼，請按一下
查看原始碼如下：
查看原始碼
Code.gs
// To learn how to use this script, refer to the documentation:
// https://developers.google.com/apps-script/samples/automations/mail-merge
/*
Copyright 2022 Martin Hawksey
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @OnlyCurrentDoc
*/
/**
* Change these to match the column names you are using for email
* recipient addresses and email sent column.
*/
const RECIPIENT_COL = "Recipient";
const EMAIL_SENT_COL = "Email Sent";
/**
* Creates the menu item "Mail Merge" for user to run scripts on drop-down.
*/
function onOpen() {
const ui = SpreadsheetApp.getUi();
ui.createMenu('Mail Merge')
.addItem('Send Emails', 'sendEmails')
.addToUi();
}
/**
* Sends emails from sheet data.
* @param {string} subjectLine (optional) for the email draft message
* @param {Sheet} sheet to read data from
*/
function sendEmails(subjectLine, sheet=SpreadsheetApp.getActiveSheet()) {
// option to skip browser prompt if you want to use this code in other projects
if (!subjectLine){
subjectLine = Browser.inputBox("Mail Merge",
"Type or copy/paste the subject line of the Gmail " +
"draft message you would like to mail merge with:",
Browser.Buttons.OK_CANCEL);
if (subjectLine === "cancel" || subjectLine == ""){
// If no subject line, finishes up
return;
}
}
// Gets the draft Gmail message to use as a template
const emailTemplate = getGmailTemplateFromDrafts_(subjectLine);
// Gets the data from the passed sheet
const dataRange = sheet.getDataRange();
// Fetches displayed values for each row in the Range HT Andrew Roberts
// https://mashe.hawksey.info/2020/04/a-bulk-email-mail-merge-with-gmail-and-google-sheets-solution-evolution-using-v8/#comment-187490
// @see https://developers.google.com/apps-script/reference/spreadsheet/range#getdisplayvalues
const data = dataRange.getDisplayValues();
// Assumes row 1 contains our column headings
const heads = data.shift();
// Gets the index of the column named 'Email Status' (Assumes header names are unique)
// @see http://ramblings.mcpher.com/Home/excelquirks/gooscript/arrayfunctions
const emailSentColIdx = heads.indexOf(EMAIL_SENT_COL);
// Converts 2d array into an object array
// See https://stackoverflow.com/a/22917499/1027723
// For a pretty version, see https://mashe.hawksey.info/?p=17869/#comment-184945
const obj = data.map(r => (heads.reduce((o, k, i) => (o[k] = r[i] || '', o), {})));
// Creates an array to record sent emails
const out = [];
// Loops through all the rows of data
obj.forEach(function(row, rowIdx){
// Only sends emails if email_sent cell is blank and not hidden by a filter
if (row[EMAIL_SENT_COL] == ''){
try {
const msgObj = fillInTemplateFromObject_(emailTemplate.message, row);
// See https://developers.google.com/apps-script/reference/gmail/gmail-app#sendEmail(String,String,String,Object)
// If you need to send emails with unicode/emoji characters change GmailApp for MailApp
// Uncomment advanced parameters as needed (see docs for limitations)
GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
htmlBody: msgObj.html,
// bcc: 'a.bcc@email.com',
// cc: 'a.cc@email.com',
// from: 'an.alias@email.com',
// name: 'name of the sender',
// replyTo: 'a.reply@email.com',
// noReply: true, // if the email should be sent from a generic no-reply email address (not available to gmail.com users)
attachments: emailTemplate.attachments,
inlineImages: emailTemplate.inlineImages
});
// Edits cell to record email sent date
out.push([new Date()]);
} catch(e) {
// modify cell to record error
out.push([e.message]);
}
} else {
out.push([row[EMAIL_SENT_COL]]);
}
});
// Updates the sheet with new data
sheet.getRange(2, emailSentColIdx+1, out.length).setValues(out);
/**
* Get a Gmail draft message by matching the subject line.
* @param {string} subject_line to search for draft message
* @return {object} containing the subject, plain and html message body and attachments
*/
function getGmailTemplateFromDrafts_(subject_line){
try {
// get drafts
const drafts = GmailApp.getDrafts();
// filter the drafts that match subject line
const draft = drafts.filter(subjectFilter_(subject_line))[0];
// get the message object
const msg = draft.getMessage();
// Handles inline images and attachments so they can be included in the merge
// Based on https://stackoverflow.com/a/65813881/1027723
// Gets all attachments and inline image attachments
const allInlineImages = draft.getMessage().getAttachments({includeInlineImages: true,includeAttachments:false});
const attachments = draft.getMessage().getAttachments({includeInlineImages: false});
const htmlBody = msg.getBody();
// Creates an inline image object with the image name as key
// (can't rely on image index as array based on insert order)
const img_obj = allInlineImages.reduce((obj, i) => (obj[i.getName()] = i, obj) ,{});
//Regexp searches for all img string positions with cid
const imgexp = RegExp('<img.*?src="cid:(.*?)".*?alt="(.*?)"[^\>]+>', 'g');
const matches = [...htmlBody.matchAll(imgexp)];
//Initiates the allInlineImages object
const inlineImagesObj = {};
// built an inlineImagesObj from inline image matches
matches.forEach(match => inlineImagesObj[match[1]] = img_obj[match[2]]);
return {message: {subject: subject_line, text: msg.getPlainBody(), html:htmlBody},
attachments: attachments, inlineImages: inlineImagesObj };
} catch(e) {
throw new Error("Oops - can't find Gmail draft");
}
/**
* Filter draft objects with the matching subject linemessage by matching the subject line.
* @param {string} subject_line to search for draft message
* @return {object} GmailDraft object
*/
function subjectFilter_(subject_line){
return function(element) {
if (element.getMessage().getSubject() === subject_line) {
return element;
}
}
}
}
/**
* Fill template string with data object
* @see https://stackoverflow.com/a/378000/1027723
* @param {string} template string containing {{}} markers which are replaced with data
* @param {object} data object used to replace {{}} markers
* @return {object} message replaced with data
*/
function fillInTemplateFromObject_(template, data) {
// We have two templates one for plain text and the html body
// Stringifing the object means we can do a global replace
let template_string = JSON.stringify(template);
// Token replacement
template_string = template_string.replace(/{{[^{}]+}}/g, key => {
return escapeData_(data[key.replace(/[{}]+/g, "")] || "");
});
return JSON.parse(template_string);
}
/**
* Escape cell data to make JSON safe
* @see https://stackoverflow.com/a/9204218/1027723
* @param {string} str to escape JSON special characters from
* @return {string} escaped string
*/
function escapeData_(str) {
return str
.replace(/[\\]/g, '\\\\')
.replace(/[\"]/g, '\\\"')
.replace(/[\/]/g, '\\/')
.replace(/[\b]/g, '\\b')
.replace(/[\f]/g, '\\f')
.replace(/[\n]/g, '\\n')
.replace(/[\r]/g, '\\r')
.replace(/[\t]/g, '\\t');
};
}
修正規則
您可以根據需求，視需要編輯自動合併郵件功能。
你可以視需要變更原始碼，
新增密件副本、副本、回覆或寄件者電子郵件參數
範例程式碼含有一些額外參數，目前
註解，讓您控制要傳送電子郵件的帳戶名稱
「寄件者」、「回覆電子郵件地址」和「密件副本」和「副本」電子郵件地址
透過移除正斜線來啟用您要新增的參數
每個端點前方的 //。
以下範例顯示 sendEmails 的摘錄內容
函數，以啟用大部分的電子郵件參數：
GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
htmlBody: msgObj.html,
bcc: 'bcc@example.com',
cc: 'cc@example.com',
from: 'from.alias@example.com',
name: 'name of the sender',
replyTo: 'reply@example.com',
// noReply: true, // if the email should be sent from a generic no-reply email address (not available to gmail.com users)
在上述範例中，noReply 參數仍在註解中
因為已設定 replyTo 參數。
在電子郵件中加入萬國碼 (Unicode) 字元
如要在電子郵件中加入表情符號等萬國碼 (Unicode) 字元，您可以
如要使用郵件服務，而非 Gmail 服務，請更新驗證碼。
在程式碼範例中，更新以下這行內容：
GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
使用下列程式碼取代這一行：
MailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
貢獻者
此樣本由 Martin Hawksey 所建立，
學習設計與技術主管：
愛丁堡未來研究所 (Edinburgh Futures Institute)，作者和 Google Developers 專家。
這個範例是由 Google 在 Google Developers 專家的協助下維護。
後續步驟
