Sheets Mail Merge

276 views
Skip to first unread message

Eric Tuñon

unread,
Jan 22, 2024, 12:02:36 PM1/22/24
to Google Apps Script Community
Hello everyone, thank you for letting me into your community, I'm looking for help on a small project I've started, at work we need a Mail Merge solution, so I took the initiative and started this project, I do have a small background in programming, so it wasn't that difficult, and I had actually already finished the project, but suddenly every email it sends now is incomplete.
Below you can see the Draft the sheet is supposed to send, it's 4 items. 
Draft template.png
-
And this is the sheet.
Sheet.png
-
But for some reason, it only these 2 items, no matter how much I change the Sheet.
mail.png
-

I've tried changing the column's names, and formatting to no avail, I thought the Script wasn't the problem because when the issue started I didn't even change the code from the version that was working.

What's also weird is I tested by making an exact copy of the Mail Merge project from Google and it had the same issue, so could it be something with my Google account? 🤔
It would help if you guys could test it on your end and see if it works, to see if it is something with my account.

Below is the code, you'll be able to see it's based on the Mail Merge example provided by Google, with some changes, thanks in advance guys!
P.S. The Send Email button is set to run the sendEmails function and I had a pop-up to confirm/cancel sending the emails, but opted to remove it to speed up my testing.
-----

function sendEmails(subjectLine, sheet=SpreadsheetApp.getActiveSheet()){
  /*
  var warningChoice = Browser.msgBox("MassMail", "Before sending out these emails please double check all the information!", Browser.Buttons.OK_CANCEL);
  if(warningChoice==='cancel'){
    throw new ("Action succesfully cancelled - Emails not sent");
    return;
  }*/

  //Change these to match the column names you are using for email recipient addresses and email sent column.
  const RECIPIENT_COL  = "recipientEmail";
  const TIME_SENT_COL = "timeSent";
  const SEND_STATUS_COL = "sendStatus";
 
  // Gets the draft Gmail message to use as a template
  const emailTemplate = getGmailTemplateFromDrafts_(sheet.getRange('T2').getValue());
 
  // Gets the data from the 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(TIME_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[SEND_STATUS_COL] == 'Send'){
      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,
          // cc: 'a....@email.com',
          // bcc: 'a....@email.com',
          // from: 'an.a...@email.com',
          // name: 'name of the sender',
          // replyTo: 'a.r...@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[TIME_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');
  };
}
Reply all
Reply to author
Forward
0 new messages