Tworzenie kreatora e-maili za pomocą Gmaila i Arkuszy Google

Poziom kodowania: początkujący
Czas trwania: 10 minut
Typ projektu: automatyzacja z menu niestandardowym

Cele

• Dowiedz się, co robi rozwiązanie.
• Dowiedz się, jakie funkcje pełnią usługi Apps Script w rozwiązaniu.
• Skonfiguruj skrypt.
• Uruchom skrypt.

Informacje o rozwiązaniu

Automatyczne wypełnianie szablonu e-maila danymi z Arkuszy. E-maile są wysyłane z Twojego konta Gmail, dzięki czemu możesz odpowiadać na wiadomości od odbiorców.

Ważne: ten przykład kreatora e-maili podlega limitom e-maili opisanym w limitach usług Google.

Jak to działa

Tworzysz szablon wersji roboczej Gmaila z symbolami zastępczymi, które odpowiadają danym w arkuszu kalkulacyjnym Arkuszy. Każdy nagłówek kolumny w arkuszu reprezentuje tag obiektu zastępczego. Skrypt wysyła informacje o każdym symbolu zastępczym z arkusza kalkulacyjnego do miejsca odpowiedniego tagu symbolu zastępczego w wersji roboczej e-maila.

Usługi Apps Script

To rozwiązanie korzysta z tych usług:

• Usługa Gmail: pobiera, odczytuje i wysyła wersję roboczą e-maila, którą chcesz wysłać do odbiorców.
  • Jeśli Twój e-mail zawiera znaki Unicode, takie jak emoji, użyj usługi poczty. Dowiedz się, jak zaktualizować kod, aby uwzględnić w e-mailu znaki Unicode.
• Usługa arkusza kalkulacyjnego: wypełnia symbole zastępcze w e-mailu spersonalizowanymi informacjami dla każdego odbiorcy.

Wolisz uczyć się, oglądając filmy? Na kanale Google Workspace Developers znajdziesz filmy z poradami, wskazówkami i informacjami o najnowszych funkcjach. Zasubskrybuj

Wymagania wstępne

Aby użyć tego przykładu, musisz spełnić te wymagania wstępne:

• Konto Google (w przypadku kont Google Workspace może być wymagana zgoda administratora).
• przeglądarkę internetową z dostępem do internetu,

Konfigurowanie skryptu

Aby skonfigurować skrypt, wykonaj te czynności:

Tworzenie projektu Apps Script

1. Kliknij poniższy przycisk, aby utworzyć kopię przykładowego arkusza kalkulacyjnego Gmail/Arkusze – korespondencja seryjna. Projekt Apps Script dla tego rozwiązania jest dołączony do arkusza kalkulacyjnego.

   Utwórz kopię

2. W skopiowanym arkuszu kalkulacyjnym zaktualizuj kolumnę Odbiorcy, wpisując adresy e-mail, których chcesz użyć w kreatorze e-maili.

3. (Opcjonalnie) Dodaj, edytuj lub usuń kolumny, aby dostosować dane, które chcesz uwzględnić w szablonie e-maila.

Jeśli zmienisz nazwy kolumn Odbiorca lub Wysłano e-maila, musisz zaktualizować odpowiedni kod w projekcie Apps Script. Projekt Apps Script możesz otworzyć z arkusza kalkulacyjnego, wybierając Rozszerzenia > Apps Script.

Tworzenie szablonu e-maila

1. Utwórz wersję roboczą e-maila na koncie Gmail. Aby uwzględnić w e-mailu dane z arkusza kalkulacyjnego, użyj symboli zastępczych odpowiadających nazwom kolumn ujętych w nawiasy klamrowe, np. {{First name}}.
   • Jeśli sformatujesz tekst w e-mailu, musisz też sformatować nawiasy symboli zastępczych.
   • W przypadku zmiennych tymczasowych wielkość liter ma znaczenie i muszą one dokładnie pasować do nagłówków kolumn.
2. Skopiuj wiersz tematu wersji roboczej e-maila.

Uruchamianie skryptu

1. W arkuszu kliknij kreator e-maili > Wyślij e-maile. Aby wyświetlić to menu niestandardowe, może być konieczne odświeżenie strony.
2. Gdy pojawi się odpowiedni komunikat, autoryzuj skrypt. <<../_snippets/oauth.md>>
3. Ponownie kliknij Kreator e-maili > Wyślij e-maile.
4. Wklej temat szablonu e-maila i kliknij OK.

Jeśli zastosujesz filtr do arkusza, skrypt nadal będzie wysyłać e-maile do odfiltrowanych uczestników, ale nie doda sygnatury czasowej.

Sprawdź kod

Aby sprawdzić kod Apps Script tego rozwiązania, kliknij Wyświetl kod źródłowy:

Pokaż kod źródłowy

Code.gs

solutions/automations/mail-merge/Code.js

Wyświetl w GitHubie

// 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
  let processedSubjectLine = subjectLine;
  if (!processedSubjectLine) {
    processedSubjectLine = 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 (processedSubjectLine === "cancel" || processedSubjectLine === "") {
      // If no subject line, finishes up
      return;
    }
  }

  // Gets the draft Gmail message to use as a template
  const emailTemplate = getGmailTemplateFromDrafts_(processedSubjectLine);

  // 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] || "";
      return o;
    }, {}),
  );

  // Creates an array to record sent emails
  const out = [];

  // Loops through all the rows of data
  obj.forEach((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: '[e-mail]',
          // cc: '[e-mail]',
          // from: '[e-mail]',
          // name: 'name of the sender',
          // replyTo: '[e-mail]',
          // 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;
        return obj;
      }, {});

      //Regexp searches for all img string positions with cid
      const imgexp = /<img.*?src="cid:(.*?)".*?alt="(.*?)"[^\>]+>/g;
      const matches = [...htmlBody.matchAll(imgexp)];

      //Initiates the allInlineImages object
      const inlineImagesObj = {};
      for (const match of matches) {
        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 (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");
  }
}

Reguły przekształcania

Możesz edytować automatyzację kreatora e-maili, aby dostosować ją do swoich potrzeb. Poniższe przykłady pokazują kilka opcjonalnych zmian, które możesz wprowadzić w kodzie źródłowym.

Dodawanie parametrów e-maila UDW, DW, Odpowiedź do lub Od

Przykładowy kod zawiera kilka dodatkowych parametrów, które są zakomentowane i umożliwiają kontrolowanie nazwy konta, z którego wysyłany jest e-mail, adresów e-mail, na które można odpowiadać, oraz adresów e-mail w polach UDW i DW.

Aktywuj parametry, które chcesz dodać, usuwając ukośniki // przed każdym z nich.

Poniższy przykład pokazuje fragment funkcji sendEmails , która aktywuje większość parametrów e-maila:

GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
         htmlBody: msgObj.html,
         bcc: '[e-mail]',
         cc: '[e-mail]',
         from: '[e-mail]',
         name: 'name of the sender',
         replyTo: '[e-mail]',
        // noReply: true, // if the email should be sent from a generic no-reply email address (not available to gmail.com users)

W poprzednim przykładzie parametr noReply jest nadal wykomentowany, ponieważ ustawiony jest parametr replyTo.

Używanie znaków Unicode w e-mailach

Jeśli chcesz uwzględnić w e-mailach znaki Unicode, takie jak emoji, musisz zaktualizować kod, aby używać usługi poczty zamiast usługi Gmail.

W przykładowym kodzie zaktualizuj ten wiersz:

GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {

Zastąp wiersz tym kodem:

MailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {

Współtwórcy

Przykładowy arkusz został utworzony przez Martina Hawkseya, lidera ds. projektowania i technologii uczenia się w Edinburgh Futures Institute, blogera i eksperta Google ds. deweloperów.

• Martina znajdziesz na Twitterze: @mhawksey.
• Przeczytaj posty na blogu Martina dotyczące Apps Script.
• Oglądaj serię filmów Martina w YouTube, Totally Unscripted.

Ten przykład jest obsługiwany przez Google przy pomocy ekspertów Google Developers.

Dalsze kroki

• Niestandardowe menu w Google Workspace
• Rozszerzanie Arkuszy