कोडिंग का लेवल: बिगिनर
अवधि: 10 मिनट
प्रोजेक्ट टाइप: कस्टम मेन्यू की मदद से ऑटोमेशन
मकसद
- समझें कि समाधान क्या करता है.
- यह समझना कि Apps Script सेवाएं
समाधान.
- स्क्रिप्ट सेट अप करें.
- स्क्रिप्ट चलाएं.
इस समाधान के बारे में जानकारी
ईमेल टेंप्लेट में, Google Sheets के डेटा का इस्तेमाल अपने-आप होने की सुविधा चालू करें. कॉन्टेंट बनाने
ईमेल आपके Gmail खाते से भेजे जाते हैं, ताकि आप
पाने वाले के जवाब.
अहम जानकारी: मेल मर्ज का यह नमूना, बताई गई ईमेल सीमाओं के हिसाब से है
Google की सेवाओं के लिए कोटा में.
![मेल मर्ज का उदाहरण](https://developers-dot-devsite-v2-prod.appspot.com/static/apps-script/samples/images/mail-merge.gif?authuser=7&hl=hi)
यह कैसे काम करता है
प्लेसहोल्डर का इस्तेमाल करके, Gmail ड्राफ़्ट टेंप्लेट बनाया जाता है
स्प्रेडशीट में मौजूद डेटा से मेल खाता है. हर कॉलम का हेडर
जो प्लेसहोल्डर टैग को दिखाता है. स्क्रिप्ट इसके लिए जानकारी भेजती है
हर प्लेसहोल्डर को स्प्रेडशीट से उसकी जगह पर ले जाएं
प्लेसहोल्डर टैग होना चाहिए.
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');
};
}
बदलाव
मेल मर्ज के ऑटोमेशन में अपनी ज़रूरत के हिसाब से बदलाव किया जा सकता है.
नीचे कुछ वैकल्पिक बदलाव दिए गए हैं, जो आप सोर्स कोड में कर सकते हैं.
गुप्त कॉपी, कॉपी, जवाब देने की सुविधा या ईमेल से जुड़े पैरामीटर जोड़ें
सैंपल कोड में, फ़िलहाल कुछ अन्य पैरामीटर शामिल हैं.
टिप्पणी में कहा गया था कि इससे आपको उस खाते का नाम कंट्रोल करने की सुविधा मिलती है जिस पर ईमेल भेजा जाता है
गुप्त कॉपी और कॉपी ईमेल पते के साथ-साथ, ईमेल पतों के जवाब देने की सुविधा मिलती है.
फ़ॉरवर्ड स्लैश हटाकर, वे पैरामीटर चालू करें जिन्हें जोड़ना है
हर बॉक्स के पहले //
.
नीचे दिया गया सैंपल, 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 सेवा के बजाय मेल सेवा का उपयोग करने के लिए कोड को अपडेट करना होगा.
सैंपल कोड में, इस लाइन को अपडेट करें:
GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
लाइन को नीचे दिए गए कोड से बदलें:
MailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
योगदानकर्ता
इस सैंपल को लर्निंग डिज़ाइन ऐंड टेक्नोलॉजी लीड, मार्टिन हॉक्सी ने बनाया है
एडिनबर्ग फ़्यूचर्स इंस्टिट्यूट, ब्लॉगर, और Google डेवलपर एक्सपर्ट.
Google इस सैंपल को मैनेज करता है. इसके लिए, Google Developer के विशेषज्ञों की मदद ली जाती है.
अगले चरण