Gmail と Google スプレッドシートでメールへの差し込みを作成する

コーディングレベル: 初級
所要時間: 10 分
プロジェクトタイプ: カスタムメニューを使用した自動化

目標

ソリューションの機能について理解する。
ソリューション内での Apps Script サービスの機能について理解する。
スクリプトを設定する。
スクリプトを実行する。

このソリューションについて

スプレッドシートのデータを使用してメールテンプレートを自動的に入力します。メールは Gmail アカウントから送信されるため、受信者の返信に対応できます。

重要: このメールへの差し込みのサンプルには、Google サービスの割り当てで説明されているメールの上限が適用されます。

Google スプレッドシートから Gmail の下書きにデータを取得するメールへの差し込みの自動化。

仕組み

Gmail の下書きテンプレートを作成します。このテンプレートには、Google スプレッドシートのデータに対応するプレースホルダが含まれています。シートの各列ヘッダーはプレースホルダタグを表します。スクリプトは、スプレッドシートから各プレースホルダの情報をメールの下書きの対応するプレースホルダタグの場所に送信します。

Apps Script サービス

このソリューションでは、次のサービスを使用します。

Gmail サービス: 受信者に送信する下書きメールを取得、読み取り、送信します。
- メールに絵文字などの Unicode 文字が含まれている場合は、メールサービスを使用してください。メールに Unicode 文字を含めるようにコードを更新する方法をご覧ください。
スプレッドシートサービス: 各受信者のパーソナライズされた情報でメールのプレースホルダを埋めます。

前提条件

このサンプルを使用するには、次の前提条件を満たす必要があります。

Google アカウント（Google Workspace アカウントの場合、管理者の承認が必要となる可能性があります）。
インターネットにアクセスできるウェブブラウザ。

スクリプトを設定する

次の手順に沿ってスクリプトを設定します。

Apps Script プロジェクトを作成する

次のボタンをクリックして、Gmail/スプレッドシートの差し込み印刷 のサンプルスプレッドシートのコピーを作成します。このソリューションの Apps Script プロジェクトは、スプレッドシートに添付されています。

コピーを作成
コピーしたスプレッドシートで、メールへの差し込みで使用するメールアドレスで [受信者] 列を更新します。
（省略可）列を追加、編集、削除して、メールテンプレートに含めるデータをカスタマイズします。

[受信者] 列または [メール送信済み] 列の名前を変更する場合は、Apps Script プロジェクトで対応するコードを更新する必要があります。スプレッドシートから Apps Script プロジェクトを開くには、 [拡張機能]> [Apps Script] を選択します。

メールテンプレートを作成する

Gmail アカウントで、メールの下書きを作成します。スプレッドシートのデータをメールに含めるには、中かっこで囲まれた列名に対応するプレースホルダ（{{First name}} など）を使用します。
- メールのテキストの書式を設定する場合は、プレースホルダの角かっこも書式設定する必要があります。
- プレースホルダでは大文字と小文字が区別されます。列ヘッダーと完全に一致している必要があります。
メールの下書きの件名をコピーします。

スクリプトを実行する

スプレッドシートで、[**差し込み印刷**] > [**メールを送信**] をクリックします。このカスタムメニューが表示されない場合は、ページの更新が必要になることがあります。
メッセージが表示されたら、スクリプトを承認します。

OAuth 同意画面に「このアプリは確認されていません」という警告が表示された場合は、 [詳細]> [{プロジェクト名}に移動（安全ではありません）] を選択して続行します。
[**差し込み印刷**] [**>**] [**メールを送信**] をもう一度クリックします。
メールテンプレートの件名を貼り付けて [OK] をクリックします。

シートにフィルタを適用した場合でも、スクリプトはフィルタされた参加者にメールを送信しますが、タイムスタンプは追加されません。

コードを確認する

このソリューションの Apps Script コードを確認するには、 [ソースコードを表示]をクリックします:

ソースコードを表示

Code.gs

solutions/automations/mail-merge/Code.js

GitHub で表示

// 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: '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;
        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");
  }
}

修正

メールへの差し込みの自動化は、ニーズに合わせて編集できます。次の例では、ソースコードに加えることができるオプションの変更をいくつか示します。

Bcc、Cc、ReplyTo、From のメールパラメータを追加する

サンプルコードには、メールの送信元アカウントの名前、返信先のメールアドレス、Bcc と Cc のメールアドレスを制御できる追加のパラメータがいくつか含まれています。これらのパラメータはコメントアウトされています。

追加するパラメータを有効にするには、各パラメータの先頭にあるスラッシュ // を削除します。

次のサンプルは、ほとんどのメールパラメータを有効にする 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)

上記のサンプルでは、replyTo パラメータが設定されているため、noReply パラメータはコメントアウトされたままです。

メールに Unicode 文字を含める

メールに絵文字などの Unicode 文字を含める場合は、 Gmail サービスではなくメールサービスを使用するようにコードを更新する必要があります。

サンプルコードで、次の行を更新します。

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

この行を次のコードに置き換えます。

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

寄稿者

このサンプルは、エディンバラフューチャーズインスティテュートのラーニングデザインおよびテクノロジーリード、ブロガー、Google デベロッパーエキスパートの Martin Hawksey が作成しました。

Martin の Twitter アカウントは @mhawksey です。
Martin の Apps Script 関連のブログ投稿をご覧ください。
Martin の YouTube 番組「Totally Unscripted」をご覧ください。

このサンプルは、Google デベロッパーエキスパートの協力を得て Google が管理しています。

Gmail と Google スプレッドシートでメールへの差し込みを作成する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

目標