Cấp độ lập trình: Cơ bản
Thời lượng: 10 phút
Loại dự án: Tự động hoá bằng trình đơn tuỳ chỉnh
Mục tiêu
- Tìm hiểu vai trò của giải pháp.
- Hiểu chức năng của các dịch vụ Apps Script trong giải pháp.
- Thiết lập tập lệnh.
- Chạy tập lệnh.
Giới thiệu về giải pháp này
Tự động điền dữ liệu từ Google Trang tính vào mẫu email. Email
được gửi từ tài khoản Gmail của bạn để bạn có thể trả lời
thư trả lời của người nhận.
Lưu ý quan trọng: Mẫu hợp nhất thư này phải tuân thủ các giới hạn email được mô tả trong phần Hạn mức cho các dịch vụ của Google.
Cách hoạt động
Bạn tạo một mẫu nháp trong Gmail với phần giữ chỗ tương ứng với dữ liệu trong bảng tính Trang tính. Mỗi tiêu đề cột trong trang tính đại diện cho một thẻ giữ chỗ. Tập lệnh sẽ gửi thông tin cho từng phần giữ chỗ trong bảng tính đến vị trí của thẻ phần giữ chỗ tương ứng trong thư nháp.
Dịch vụ Apps Script
Giải pháp này sử dụng các dịch vụ sau:
- Dịch vụ Gmail–Nhận, đọc và gửi email nháp bạn muốn gửi cho người nhận.
- Dịch vụ bảng tính – Điền thông tin được cá nhân hoá cho từng người nhận vào phần giữ chỗ email.
Điều kiện tiên quyết
Để sử dụng mẫu này, bạn cần có các điều kiện tiên quyết sau:
- Tài khoản Google (các tài khoản Google Workspace có thể
yêu cầu quản trị viên phê duyệt).
- Một trình duyệt web có quyền truy cập vào Internet.
Thiết lập tập lệnh
Tạo dự án Apps Script
- Nhấp vào nút sau để tạo bản sao của bảng tính mẫu Gmail/Trang tính hợp nhất thư.
Dự án Apps Script cho giải pháp này được đính kèm vào bảng tính.
Tạo bản sao
- Trong bảng tính đã sao chép, hãy cập nhật cột Người nhận bằng địa chỉ email mà bạn muốn sử dụng trong tính năng hợp nhất thư.
- (Không bắt buộc) Thêm, chỉnh sửa hoặc xoá các cột để tuỳ chỉnh dữ liệu mà bạn muốn
đưa vào mẫu email của mình.
Nếu thay đổi tên của cột Người nhận hoặc cột Đã gửi email, bạn phải cập nhật mã tương ứng trong dự án Apps Script. Bạn có thể mở dự án Apps Script từ bảng tính bằng cách nhấp vào Tiện ích >
Apps Script.
Tạo mẫu email
- Trong tài khoản Gmail, hãy tạo một email nháp. Để đưa dữ liệu từ bảng tính vào email, hãy sử dụng phần giữ chỗ tương ứng với tên cột trong dấu ngoặc nhọn, chẳng hạn như
{{First name}}.
- Nếu định dạng văn bản trong email, bạn cũng phải định dạng các dấu ngoặc giữ chỗ.
- Phần giữ chỗ có phân biệt chữ hoa chữ thường và phải khớp hoàn toàn với các tiêu đề cột.
- Sao chép dòng tiêu đề email nháp.
Chạy tập lệnh
- Trong bảng tính, hãy nhấp vào Hợp nhất thư >
Gửi email. Có thể bạn cần phải làm mới trang để trình đơn tuỳ chỉnh này xuất hiện.
Khi được nhắc, hãy cho phép tập lệnh.
Nếu màn hình xin phép bằng OAuth hiển thị cảnh báo, Ứng dụng này chưa được xác minh, hãy tiếp tục bằng cách chọn Nâng cao >
Chuyển đến {Tên dự án} (không an toàn).
Nhấp lại vào Hợp nhất thư > Gửi email.
Dán dòng tiêu đề của mẫu email rồi nhấp vào OK.
Nếu bạn đã áp dụng một bộ lọc cho trang tính, tập lệnh vẫn gửi email cho những người tham gia đã lọc, nhưng sẽ không thêm dấu thời gian.
Xem lại đoạn mã
Để xem lại mã Apps Script cho giải pháp này, hãy nhấp vào phần Xem mã nguồn bên dưới:
Xem mã nguồn
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');
};
}
Sửa đổi
Bạn có thể chỉnh sửa tính năng tự động hợp nhất thư bao nhiêu tuỳ thích cho phù hợp với nhu cầu của mình.
Dưới đây là một vài thay đổi tuỳ chọn mà bạn có thể thực hiện đối với mã nguồn.
Thêm các tham số Bcc, Cc, ReplyTo hoặc Từ email
Mã mẫu này bao gồm một số tham số bổ sung mà chúng tôi hiện đã
nhận xét, cho phép bạn kiểm soát tên của tài khoản gửi
email, trả lời địa chỉ email cũng như các địa chỉ email Bcc và Cc.
Kích hoạt các thông số bạn muốn thêm bằng cách xoá dấu gạch chéo lên
// ở trước mỗi thông số.
Mẫu sau đây cho thấy phần trích dẫn từ hàm sendEmails
kích hoạt hầu hết các thông số email:
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)
Trong mẫu trên, tham số noReply vẫn được nhận xét
vì tham số replyTo đã được đặt.
Đưa các ký tự unicode vào email
Nếu muốn đưa các ký tự unicode (chẳng hạn như biểu tượng cảm xúc) vào email, bạn phải cập nhật mã để sử dụng dịch vụ Thư thay vì dịch vụ Gmail.
Trong mã mẫu, hãy cập nhật dòng sau:
GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
Thay thế dòng bằng mã sau:
MailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
Người đóng góp
Mẫu này do Martin Hawksey, Trưởng nhóm thiết kế và công nghệ học tập tại Edinburgh Futures Institute, blogger và Chuyên gia nhà phát triển của Google tạo ra.
Mẫu này được Google duy trì với sự trợ giúp của các chuyên gia nhà phát triển của Google.
Các bước tiếp theo
