Kodlama seviyesi: Başlangıç
Süre: 10 dakika
Proje türü: Özel menü olan otomasyon
Hedefler
- Çözümün ne işe yaradığını anlayın.
- Apps Komut Dosyası hizmetlerinin çözüm kapsamında neler yaptığını anlayın.
- Komut dosyasını ayarlayın.
- Komut dosyasını çalıştırın.
Bu çözüm hakkında
E-posta şablonunu Google E-Tablolar'dan alınan verilerle otomatik olarak doldurabilirsiniz. E-postalar, alıcıların yanıtlarına yanıt verebilmeniz için Gmail hesabınızdan gönderilir.
Önemli: Bu posta birleştirme örneği, Google hizmetleri için kotalar bölümünde açıklanan e-posta sınırlarına tabidir.
İşleyiş şekli
Bir E-Tablolar e-tablosundaki verilere karşılık gelen yer tutucular içeren bir Gmail taslak şablonu oluşturursunuz. Bir sayfadaki her sütun başlığı
bir yer tutucu etiketi temsil eder. Komut dosyası, e-tablodaki her bir yer tutucuya ilişkin bilgileri e-posta taslağınızdaki ilgili yer tutucu etiketin konumuna gönderir.
Apps Komut Dosyası hizmetleri
Bu çözüm aşağıdaki hizmetleri kullanır:
- Gmail hizmeti: Alıcılarınıza göndermek istediğiniz taslak e-postayı alır, okur ve gönderir.
- E-tablo hizmeti - E-posta yer tutucularını, her alıcı için kişiselleştirilmiş bilgilerle doldurur.
Ön koşullar
Bu örneği kullanmak için aşağıdaki önkoşullara ihtiyacınız vardır:
- Google Hesabı (Google Workspace hesapları için yönetici onayı gerekebilir).
- İnternete erişimi olan bir web tarayıcısı.
Komut dosyasını kurma
Apps Komut Dosyası projesini oluşturma
- Gmail/E-Tablolar Posta Birleştirme örnek e-tablosunun bir kopyasını oluşturmak için aşağıdaki düğmeyi tıklayın.
Bu çözüm için Apps Komut Dosyası projesi e-tabloya eklenmiştir.
Kopya oluştur
- Kopyalanan e-tablonuzda, Alıcılar sütununu posta birleştirmede kullanmak istediğiniz e-posta adresleriyle güncelleyin.
- (İsteğe bağlı) E-posta şablonunuza dahil etmek istediğiniz verileri özelleştirmek için sütunları ekleyin, düzenleyin veya kaldırın.
Recipient veya Email
Sent sütunlarının adını değiştirirseniz Apps Komut Dosyası projesinde ilgili kodu güncellemeniz gerekir. Apps Komut Dosyası projesini, e-tablodan Uzantılar >
Apps Komut Dosyası'nı tıklayarak açabilirsiniz.
E-posta şablonu oluşturma
- Gmail hesabınızda bir e-posta taslağı oluşturun. E-tablodaki verileri e-postanıza eklemek için
{{First name}} gibi küme parantezleri içine alınmış sütun adlarına karşılık gelen yer tutucular kullanın.
- E-postadaki metni biçimlendirirseniz yer tutucu parantezleri de biçimlendirmeniz gerekir.
- Yer tutucular büyük/küçük harfe duyarlıdır ve sütun başlıklarıyla tam olarak eşleşmelidir.
- E-posta taslağınızın konu satırını kopyalayın.
Komut dosyasını çalıştırma
- E-tabloda, Posta Birleştirme >
E-posta Gönder'i tıklayın. Bu özel menünün görünmesi için sayfayı yenilemeniz gerekebilir.
İstendiğinde komut dosyasını yetkilendirin.
OAuth izin ekranında Bu uygulama doğrulanmadı uyarısı gösteriliyorsa Gelişmiş >
{Project Name} (güvenli değil) uygulamasına git'i seçerek devam edin.
Posta Birleştirme > E-posta Gönder'i tekrar tıklayın.
E-posta şablonunun konu satırını yapıştırın ve Tamam'ı tıklayın.
Sayfaya filtre uyguladıysanız komut dosyası filtrelenen katılımcılara e-posta göndermeye devam eder ancak zaman damgası eklenmez.
Kodu inceleyin
Bu çözümün Apps Komut Dosyası kodunu incelemek için aşağıdaki Kaynak kodu görüntüle'yi tıklayın:
Kaynak kodu göster
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');
};
}
Değişiklikler
Posta birleştirme otomasyonunu ihtiyaçlarınıza uyacak şekilde düzenleyebilirsiniz.
Aşağıda, kaynak kodunda yapabileceğiniz birkaç isteğe bağlı değişiklik verilmiştir.
Bcc, Cc, ReplyTo veya From email parametreleri ekleme
Örnek kod, e-postanın gönderildiği hesabın adını, e-posta adreslerini yanıtlamayı, Bcc ve Cc e-posta adreslerini kontrol etmenize olanak tanıyan, şu anda açıklama yapılmış bir dizi ek parametre içerir.
Her birinin önündeki eğik çizgileri // kaldırarak, eklemek istediğiniz parametreleri etkinleştirin.
Aşağıdaki örnekte, e-posta parametrelerinin çoğunu etkinleştiren sendEmails işlevinden bir alıntı gösterilmektedir:
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)
Yukarıdaki örnekte, replyTo parametresi ayarlandığı için noReply parametresi hâlâ yorumlanmamış durumda.
E-postalarınıza Unicode karakterleri dahil edin
E-postalarınıza emoji gibi Unicode karakterler eklemek istiyorsanız kodu, Gmail hizmeti yerine Posta hizmetini kullanacak şekilde güncellemeniz gerekir.
Örnek kodda aşağıdaki satırı güncelleyin:
GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
Satırı aşağıdaki kodla değiştirin:
MailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
Katılımcılar
Örnek, Edburgh Futures Institute'un Öğrenim Tasarım ve Teknoloji Lideri,
blog yazarı ve Google Geliştirici Uzmanı Martin Hawksey tarafından oluşturuldu.
Bu örnek, Google Geliştirici Uzmanlarının yardımıyla Google tarafından sağlanmaktadır.
Sonraki adımlar
