إنشاء دمج بريد باستخدام Gmail &amp؛ "جداول بيانات Google"

مستوى الترميز:
المبتدئ المدة: 10 دقائق
نوع المشروع: التشغيل المبرمَج باستخدام قائمة مخصّصة

هل تفضّل التعلُّم من خلال فيديو؟
تقدِّم قناة Google Workspace Developers تطبيقات عن النصائح وآخر الميزات.

الأهداف

  • فهم آلية عمل الحل
  • تعرَّف على ما تقوم به خدمات "برمجة تطبيقات Google" ضمن الحل.
  • إعداد النص البرمجي.
  • شغِّل النص البرمجي.

معلومات عن هذا الحل

يمكنك ملء نموذج رسالة إلكترونية تلقائيًا بالبيانات من "جداول بيانات Google". يتم إرسال الرسائل الإلكترونية من حسابك على Gmail حتى تتمكن من الردّ على ردود المُستلِم.

ملاحظة مهمة: يخضع نموذج دمج البريد هذا لحدود البريد الإلكتروني الموضحة في حصص خدمات Google.

مثال على دمج البريد

آلية العمل

يمكنك إنشاء نموذج لمسودة Gmail مع عناصر نائبة تتوافق مع البيانات في جدول بيانات. يمثّل كل عنوان عمود في ورقة بيانات علامة عنصر نائب. يرسل النص البرمجي معلومات لكل عنصر نائب من جدول البيانات إلى موقع علامة العنصر النائب المقابلة في مسودة البريد الإلكتروني.

خدمات برمجة التطبيقات

يستخدم هذا الحل الخدمات التالية:

المتطلبات الأساسية

لاستخدام هذا النموذج، ستحتاج إلى المتطلبات الأساسية التالية:

  • حساب على Google (قد تحتاج حسابات Google Workspace إلى موافقة المشرف)
  • متصفّح ويب يمكنه الاتصال بالإنترنت

إعداد النص البرمجي

إنشاء مشروع "برمجة تطبيقات Google"

  1. انقر على الزر التالي لإنشاء نسخة من نموذج جدول البيانات لدمج Gmail/"جداول بيانات Google". تم إرفاق مشروع برمجة التطبيقات لهذا الحلّ بجدول البيانات.
    إنشاء نسخة
  2. في جدول البيانات المنسوخ، حدِّث عمود المستلمون بعناوين البريد الإلكتروني التي تريد استخدامها في دمج البريد.
  3. (اختياري) أضِف أعمدة أو عدِّلها أو أزِلها لتخصيص البيانات التي تريد تضمينها في نموذج الرسالة الإلكترونية.

إذا غيّرت اسم عمود المستلِم أو عمود البريد الإلكتروني، عليك تحديث الرمز المقابل في مشروع برمجة التطبيقات. يمكنك فتح مشروع برمجة التطبيقات من جدول البيانات عن طريق النقر على الإضافات > برمجة التطبيقات.

إنشاء نموذج رسالة إلكترونية

  1. في حسابك على Gmail، أنشِئ مسودة رسالة إلكترونية. لتضمين البيانات من جدول البيانات في بريدك الإلكتروني، يمكنك استخدام العناصر النائبة المقابلة لأسماء الأعمدة المحاطة بأقواس متعرجة، مثل {{First name}}.
    • إذا أردت تنسيق النص في الرسالة الإلكترونية، عليك أيضًا تنسيق قوسين.
    • العناصر النائبة حساسة لحالة الأحرف، ويجب أن تتطابق تمامًا مع عناوين الأعمدة.
  2. انسخ سطر الموضوع في مسودة الرسالة الإلكترونية.

تشغيل النص البرمجي

  1. في جدول البيانات، انقر على دمج البريد > إرسال رسائل إلكترونية. قد تحتاج إلى إعادة تحميل الصفحة لكي تظهر هذه القائمة المخصصة.
  2. امنح الإذن للنصّ البرمجي عند مطالبتك بذلك. إذا كانت شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth تعرض التحذير، لم يتم إثبات ملكية هذا التطبيق، يمكنك المتابعة من خلال النقر على إعدادات متقدّمة > الانتقال إلى {Project Name} (غير آمن).

  3. انقر على دمج البريد > إرسال الرسائل الإلكترونية مرة أخرى.

  4. الصِق سطر موضوع نموذج الرسالة الإلكترونية وانقر على OK (حسنًا).

إذا طبّقت فلترًا على ورقة البيانات، سيواصل النص البرمجي إرسال رسائل إلكترونية إلى المشاركين الذين تمت فلترتهم، لكنّه لن يضيف الطابع الزمني.

مراجعة الرمز

لمراجعة رمز "برمجة تطبيقات Google" لهذا الحل، انقر على عرض رمز المصدر أدناه:

عرض رمز المصدر

Code.gs

Solutions/automations/mail-merge/Code.js
// 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.bbc@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 Developer.

  • ابحث عن مارتن على @mhawksey.
  • يمكنك الاطّلاع على مشاركات المدوّنة المتعلقة ببرمجة تطبيقات Google لمارتن.
  • شاهِد العرض الذي يقدّمه "مارتن" على قناة Untscripted.

تحتفظ Google بهذا النموذج بمساعدة خبراء المطوّرين في Google.

الخطوات التالية