कोडिंग लेवल: शुरुआती
अवधि: 10 मिनट
प्रोजेक्ट टाइप: कस्टम मेन्यू के साथ ऑटोमेशन
मकसद
- यह समझना कि समाधान क्या करता है.
- जानें कि समाधान में Apps Script की सेवाएं क्या करती हैं.
- स्क्रिप्ट सेट अप करें.
- स्क्रिप्ट चलाएं.
इस समाधान के बारे में जानकारी
Google Sheets के डेटा से, ईमेल टेंप्लेट में अपने-आप डेटा भरना. ये ईमेल आपके Gmail खाते से भेजे जाते हैं, ताकि आप ईमेल पाने वाले लोगों के जवाबों का जवाब दे सकें.
अहम जानकारी: मेल मर्ज के इस सैंपल पर, Google की सेवाओं के लिए कोटा में बताई गई ईमेल सीमाएं लागू होती हैं.
यह कैसे काम करता है
आपने Gmail में ड्राफ़्ट टेंप्लेट बनाया है. इसमें प्लेसहोल्डर का इस्तेमाल किया गया है, जो Sheets स्प्रेडशीट में मौजूद डेटा से मेल खाते हैं. शीट में मौजूद हर कॉलम हेडर, प्लेसहोल्डर टैग को दिखाता है. स्क्रिप्ट, स्प्रेडशीट से हर प्लेसहोल्डर की जानकारी को आपके ईमेल ड्राफ़्ट में उससे जुड़े प्लेसहोल्डर टैग की जगह पर भेजती है.
Apps Script की सेवाएं
यह समाधान इन सेवाओं का इस्तेमाल करता है:
- Gmail सेवा–आपके ईमेल का ड्राफ़्ट पाती है, उसे पढ़ती है, और उसे ईमेल पाने वालों को भेजती है.
- स्प्रेडशीट सेवा–ईमेल पाने वाले हर व्यक्ति के लिए, ईमेल के प्लेसहोल्डर में उसकी पसंद के मुताबिक जानकारी भरती है.
ज़रूरी शर्तें
इस सैंपल का इस्तेमाल करने के लिए, आपको ये ज़रूरी शर्तें पूरी करनी होंगी:
- Google खाता (Google Workspace खातों के लिए, एडमिन की अनुमति की ज़रूरत पड़ सकती है).
- इंटरनेट का ऐक्सेस वाला वेब ब्राउज़र.
स्क्रिप्ट सेट अप करना
Apps Script प्रोजेक्ट बनाना
- Gmail/Sheets के मेल मर्ज टूल के उदाहरण के तौर पर दी गई स्प्रेडशीट की कॉपी बनाने के लिए, नीचे दिए गए बटन पर क्लिक करें.
इस समाधान के लिए Apps Script प्रोजेक्ट, स्प्रेडशीट से जुड़ा होता है.
कॉपी बनाना
- कॉपी की गई स्प्रेडशीट में, ईमेल पाने वाले कॉलम को उन ईमेल पतों से अपडेट करें जिनका आपको मेल मर्ज में इस्तेमाल करना है.
- (ज़रूरी नहीं) अपने ईमेल टेंप्लेट में जो डेटा शामिल करना है उसे पसंद के मुताबिक बनाने के लिए, कॉलम जोड़ें, उनमें बदलाव करें या उन्हें हटाएं.
अगर ईमेल पाने वाला या भेजा गया ईमेल कॉलम का नाम बदला जाता है, तो आपको 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');
};
}
बदलाव
अपनी ज़रूरतों के हिसाब से, मेल मर्ज ऑटोमेशन में जितने चाहें उतने बदलाव किए जा सकते हैं.
यहां कुछ ऐसे बदलाव दिए गए हैं जिन्हें सोर्स कोड में किया जा सकता है. हालांकि, ऐसा करना ज़रूरी नहीं है.
ईमेल के लिए Bcc, Cc, ReplyTo या From पैरामीटर जोड़ना
सैंपल कोड में कई अन्य पैरामीटर शामिल हैं, जिन पर फ़िलहाल टिप्पणी की गई है. इनकी मदद से, ईमेल भेजने वाले खाते का नाम, ईमेल पते के साथ-साथ गुप्त कॉपी और कॉपी के तौर पर शामिल ईमेल पते को कंट्रोल किया जा सकता है.
आपको जो पैरामीटर जोड़ने हैं उन्हें चालू करें. इसके लिए, हर पैरामीटर के आगे मौजूद फ़ॉरवर्ड स्लैश
//
हटाएं.
यहां दिए गए सैंपल में, 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
पैरामीटर सेट है.
अपने ईमेल में यूनिकोड वर्ण शामिल करना
अगर आपको अपने ईमेल में यूनिकोड वर्ण, जैसे कि इमोजी शामिल करने हैं, तो आपको Gmail की सेवा के बजाय Mail सेवा का इस्तेमाल करने के लिए कोड अपडेट करना होगा.
सैंपल कोड में, यह लाइन अपडेट करें:
GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
लाइन को इस कोड से बदलें:
MailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
योगदानकर्ता
इस सैंपल को मार्टिन हॉक्से ने बनाया है. वे Edinburgh Futures Institute में लर्निंग डिज़ाइन और टेक्नोलॉजी लीड हैं. साथ ही, वे ब्लॉगर और Google डेवलपर एक्सपर्ट भी हैं.
इस सैंपल को Google, Google Developer Experts की मदद से मैनेज करता है.
अगले चरण