【GAS】チェックがついた宛先を取得し、メール送信

Question

前提

GAS超初心者です。
GASを使用し、メール送信ツールを作成していますが、行き詰っています。
どなたかアドバイスをいただけますと大変幸いです。
よろしくお願いいたします。

実現したいこと

チェックボックスにチェックがついた宛先のデータのみ取得し、
メールの下書き作成と送信を行いたい。

発生している問題・エラーメッセージ

エラーメッセージは出ていませんが、チェックのついたデータのみを取得できません。

追記

• 参考サイトと異なる部分は宛先シートのセルAにチェックボックスを設けています。
• チェックボックスを押した時点でのメール送信ではなく、チェックが入っているデータを取得→差し込み→送信もしくは下書き作成（ボタン形式）です。

該当のソースコード

/*Step1：グローバル定数
-------------------------------------------------------------*/
const ss = SpreadsheetApp.getActiveSpreadsheet();
const mainSheet = ss.getSheetByName("Main");

/*Step2：シートオープン時にプルダウンの選択肢をセットする
-------------------------------------------------------------*/
function onOpen() {
  setRecipientListPulldown();
}

/*Step3：送信/下書きボタン押下時の処理｜onClickCreateDrafts
-------------------------------------------------------------*/
function onClickSendEmails() {
  const answer = Browser.msgBox("メールを一括送信します。よろしいですか。", Browser.Buttons.OK_CANCEL);
  if (answer === "ok") {
    batchProcessEmails("sendEmail");
    Browser.msgBox("処理が完了しました。「処理結果」列を確認してください。");
  }
}

function onClickCreateDrafts() {
  const answer = Browser.msgBox("メールの下書きを一括作成します。よろしいですか。", Browser.Buttons.OK_CANCEL);
  if (answer === "ok") {
    batchProcessEmails("createDraft");
    Browser.msgBox("処理が完了しました。「処理結果」列を確認してください。");
  }
}

/*Step4：宛先シート全行分のメールを処理する｜batchProcessEmails
-------------------------------------------------------------*/
function batchProcessEmails(action) {
  // Mainシートの入力値を取得
  const inputValues = getInputValues();
  // ログ列（R列）をクリア
  ss.getSheetByName(inputValues.recipientListName).getRange("R2:R").clear();
  // 宛先シートの入力内容を取得
  const targets = getTargets(inputValues.recipientListName);
  // 宛先シートの全行に対して送信（または下書き）を実行
  const logs = [];
  for (const target of targets) { 
      const result = processEmail(inputValues, target, action);
      logs.push([result]);
  }
  // ログ列（Q列）に結果を貼り付け
  ss.getSheetByName(inputValues.recipientListName)
    .getRange(`R2:R${logs.length + 1}`)
    .setValues(logs);
}

/*Step5：メールを1件送信または下書き作成する｜processEmail
-------------------------------------------------------------*/
function processEmail(inputValues, target, action) {
  try {
    // タイトル・本文に差込を適用
    const replacedMailTitle = getReplacedString(inputValues.mailTitle, target.replaceList);
    const replacedMailBody = getReplacedString(inputValues.mailBody, target.replaceList);

    // 添付ファイルを取得
    const attachements = [
      ...getAttachements(inputValues.attachmentFolderId, inputValues.commonAttachmentNames),
      ...getAttachements(inputValues.attachmentFolderId, target.eachAttachmentNames)
    ]

    /* メールオプションの設定
    -------------------------------------------------------------*/
    const options = {};
    if (inputValues.senderEmail) options.from = inputValues.senderEmail;
    if (inputValues.senderName) options.name = inputValues.senderName;
    if (target.cc) options.cc = target.cc;
    if (target.bcc) options.bcc = target.bcc;
    if (attachements.length) options.attachments = attachements;

    /* メール送信 or 下書き作成
    -------------------------------------------------------------*/
    if (action === "sendEmail") {
      GmailApp.sendEmail(target.to, replacedMailTitle, replacedMailBody, options);
    } else {
      GmailApp.createDraft(target.to, replacedMailTitle, replacedMailBody, options);
    }
    return "Success";
  } catch(error) {
    return error;
  }
}

/*Step6：文字列, 差込リストから差込後のテキストを取得する｜getReplacedString
-------------------------------------------------------------*/
function getReplacedString(string, replaceList) {
  let replacedString = string;
  for (const item of replaceList) {
    const before = new RegExp(`\{\{ *${item.before} *\}\}`, "g");
    replacedString = replacedString.replace(before, item.after);
  }
  return replacedString;
}

//★：チェックボックスの判定

function getCheckbox() {
  const myCell = mainSheet.getActiveCell();
  const rule = myCell.getDataValidation();
  if (rule != null) {
    const criteria = rule.getCriteriaType();
    const status = myCell.getValue()
      if ( criteria == 'CHECKBOX' && status == true) {
        const row = myCell.getRow();
        getInputValues();
         }
    }
}

/*Step7：mainシートに入力された値を取得する｜getInputValues
-------------------------------------------------------------*/
function getInputValues() {
  const inputValues =  {
    attachmentFolderId: mainSheet.getRange("B2").getValue(),    // 添付ファイル格納フォルダID
    mailTitle: mainSheet.getRange("B5").getValue(),             // メールタイトル
    mailBody: mainSheet.getRange("B6").getValue(),              // 本文
    commonAttachmentNames: [
      mainSheet.getRange("B7").getValue(),                      // 共通添付ファイル名１
      mainSheet.getRange("B8").getValue(),                      // 共通添付ファイル名２
      mainSheet.getRange("B9").getValue(),                      // 共通添付ファイル名３
    ],
    recipientListName: mainSheet.getRange("B12").getValue(),    // 宛先リストシート名    
  }
  return inputValues;
}

/*Step8：宛先リストシート名から、シートの内容を配列で取得する
-------------------------------------------------------------*/
function getTargets(recipientListName) {
  const targetsSheet = ss.getSheetByName(recipientListName);
  const sheetData = targetsSheet.getDataRange().getValues();
  const header = sheetData[0];
  const contents = sheetData.slice(1);
  const targets = contents.map((row) => {
    return {
      checkbox: [0],                            // チェックボックス
      to: row[1],                               // 宛先メールアドレス
      cc: row[2],                               // ccアドレス
      bcc: row[3],                              // bccアドレス
      replaceList: getReplaceList(header, row), // 置換内容
      eachAttachmentNames: [
        row[14],                                // 個別添付ファイル名１
        row[15],                                // 個別添付ファイル名２
        row[16],                                // 個別添付ファイル名３
      ]
    };
  });
  return targets;
}


/*Step8：ヘッダー行・値行から、置換前・置換後を格納したオブジェクトの配列を返す
-------------------------------------------------------------*/
function getReplaceList(header, row) {
  const beforeStrings = header.slice(4, 14);  // 4 - 12列目が差込項目
  const afterStrings = row.slice(4, 14);      // 4 - 12列目が差込項目
  const replaceList = [];
  beforeStrings.forEach((beforeString, index) => {
    if (beforeString) replaceList.push({
      before: beforeString,
      after: afterStrings[index]
    });
  });
  return replaceList;
}
以下省略

参考サイト

メール送信：
https://web-breeze.net/gmail-insertion-sending/
チェックボックス：
https://masagoroku.com/

Answer 1

※文字数（1つの回答欄に10000字以上は投稿不可）の関係で回答を2つに分けます。

まず修正後の全体のコードを下記に記載します。（修正した部分については後述します）　

/*Step1：グローバル定数
-------------------------------------------------------------*/
const ss = SpreadsheetApp.getActiveSpreadsheet();
const mainSheet = ss.getSheetByName("Main");

/*Step2：シートオープン時にプルダウンの選択肢をセットする
-------------------------------------------------------------*/
function onOpen() {
  setRecipientListPulldown();
}

/*Step3：送信/下書きボタン押下時の処理｜onClickCreateDrafts
-------------------------------------------------------------*/
function onClickSendEmails() {
  const answer = Browser.msgBox("メールを一括送信します。よろしいですか。", Browser.Buttons.OK_CANCEL);
  if (answer === "ok") {
    batchProcessEmails("sendEmail");
    Browser.msgBox("処理が完了しました。「処理結果」列を確認してください。");
  }
}

function onClickCreateDrafts() {
  const answer = Browser.msgBox("メールの下書きを一括作成します。よろしいですか。", Browser.Buttons.OK_CANCEL);
  if (answer === "ok") {
    batchProcessEmails("createDraft");
    Browser.msgBox("処理が完了しました。「処理結果」列を確認してください。");
  }
}

/*Step4：宛先シート全行分のメールを処理する｜batchProcessEmails
-------------------------------------------------------------*/
function batchProcessEmails(action) {
  // Mainシートの入力値を取得
  const inputValues = getInputValues();
  // ログ列（R列）をクリア
  ss.getSheetByName(inputValues.recipientListName).getRange("R2:R").clear();
  // 宛先シートの入力内容を取得
  const targets = getTargets(inputValues.recipientListName);
  // 宛先シートの全行に対して送信（または下書き）を実行
  const logs = [];
  for (const target of targets) { 
      const result = processEmail(inputValues, target, action);
      logs.push([result]);
  }
  // ログ列（Q列）に結果を貼り付け
  ss.getSheetByName(inputValues.recipientListName)
    .getRange(`R2:R${logs.length + 1}`)
    .setValues(logs);
}

/*Step5：メールを1件送信または下書き作成する｜processEmail
-------------------------------------------------------------*/
function processEmail(inputValues, target, action) {
  try {
    // タイトル・本文に差込を適用
    const replacedMailTitle = getReplacedString(inputValues.mailTitle, target.replaceList);
    const replacedMailBody = getReplacedString(inputValues.mailBody, target.replaceList);

    // 添付ファイルを取得
    const attachements = [
      ...getAttachements(inputValues.attachmentFolderId, inputValues.commonAttachmentNames),
      ...getAttachements(inputValues.attachmentFolderId, target.eachAttachmentNames)
    ]

    /* メールオプションの設定
    -------------------------------------------------------------*/
    const options = {};
    if (inputValues.senderEmail) options.from = inputValues.senderEmail;
    if (inputValues.senderName) options.name = inputValues.senderName;
    if (target.cc) options.cc = target.cc;
    if (target.bcc) options.bcc = target.bcc;
    if (attachements.length) options.attachments = attachements;

    /* メール送信 or 下書き作成
    -------------------------------------------------------------*/
    if (action === "sendEmail") {
      GmailApp.sendEmail(target.to, replacedMailTitle, replacedMailBody, options);
    } else {
      GmailApp.createDraft(target.to, replacedMailTitle, replacedMailBody, options);
    }
    return "Success";
  } catch(error) {
    return error;
  }
}

/*Step6：文字列, 差込リストから差込後のテキストを取得する｜getReplacedString
-------------------------------------------------------------*/
function getReplacedString(string, replaceList) {
  let replacedString = string;
  for (const item of replaceList) {
    const before = new RegExp(`\{\{ *${item.before} *\}\}`, "g");
    replacedString = replacedString.replace(before, item.after);
  }
  return replacedString;
}

//★：チェックボックスの判定

function getCheckbox() {
  const myCell = mainSheet.getActiveCell();
  const rule = myCell.getDataValidation();
  if (rule != null) {
    const criteria = rule.getCriteriaType();
    const status = myCell.getValue()
      if ( criteria == 'CHECKBOX' && status == true) {
        const row = myCell.getRow();
        getInputValues();
         }
    }
}

/*Step7：mainシートに入力された値を取得する｜getInputValues
-------------------------------------------------------------*/
function getInputValues() {
  const inputValues =  {
    attachmentFolderId: mainSheet.getRange("B2").getValue(),    // 添付ファイル格納フォルダID
    mailTitle: mainSheet.getRange("B5").getValue(),             // メールタイトル
    mailBody: mainSheet.getRange("B6").getValue(),              // 本文
    commonAttachmentNames: [
      mainSheet.getRange("B7").getValue(),                      // 共通添付ファイル名１
      mainSheet.getRange("B8").getValue(),                      // 共通添付ファイル名２
      mainSheet.getRange("B9").getValue(),                      // 共通添付ファイル名３
    ],
    recipientListName: mainSheet.getRange("B12").getValue(),    // 宛先リストシート名    
  }
  return inputValues;
}

/*Step8：宛先リストシート名から、シートの内容を配列で取得する
-------------------------------------------------------------*/
function getTargets(recipientListName) {
  const targetsSheet = ss.getSheetByName(recipientListName);
  const sheetData = targetsSheet.getDataRange().getValues();
  const header = sheetData[0];
  const contents = sheetData.slice(1);
  const targets = contents.map((row) => {
    return {
      checkbox: row[0],  // [修正]              // チェックボックス
      to: row[1],                               // 宛先メールアドレス
      cc: row[2],                               // ccアドレス
      bcc: row[3],                              // bccアドレス
      replaceList: getReplaceList(header, row), // 置換内容
      eachAttachmentNames: [
        row[14],                                // 個別添付ファイル名１
        row[15],                                // 個別添付ファイル名２
        row[16],                                // 個別添付ファイル名３
      ]
    };
  }).filter(e => e.checkbox === true);    // [追加]
  console.log(targets);
  return targets;
}


/*Step8：ヘッダー行・値行から、置換前・置換後を格納したオブジェクトの配列を返す
-------------------------------------------------------------*/
function getReplaceList(header, row) {
  const beforeStrings = header.slice(4, 14);  // 5 - 14列目が差込項目
  const afterStrings = row.slice(4, 14);      // 5 - 14列目が差込項目
  const replaceList = [];
  beforeStrings.forEach((beforeString, index) => {
    if (beforeString) replaceList.push({
      before: beforeString,
      after: afterStrings[index]
    });
  });
  return replaceList;
}

/* -------------------------------------------
  getAttachments
  フォルダID, ファイル名配列からファイル配列を取得する
  -------------------------------------------- */
  function getAttachements(folderId, fileNames) {
    const attachements = [];
    fileNames.forEach((fileName) => {
      if (fileName) attachements.push(getAttachement(folderId, fileName));
    })
    return attachements;
  }
  
/* ----------------------------------------
getAttachment
フォルダID, ファイル名からファイルを取得する
------------------------------------------- */
function getAttachement(folderId, fileName) {
    const files = DriveApp.getFolderById(folderId).getFilesByName(fileName);
    if (!files.hasNext()) throw Error(`添付ファイル ${fileName} が存在しません。`);
    file = files.next();
    if (files.hasNext()) throw Error(`添付ファイル ${fileName} が複数存在します。`);
    return file;
}

/* -----------------------------------------
  setRecipientListPulldown
  宛先リストシート名のプルダウンに選択肢をセットする
  ------------------------------------------ */
function setRecipientListPulldown() {
  // Mainシート以外のシート名を取得
  const values = ss.getSheets().map((sheet) => {
    const sheetName = sheet.getName()
    return sheetName !== "Main"
      ? sheetName
      : ""
  })
  // 入力規則を作成
  const rule = SpreadsheetApp.newDataValidation().requireValueInList(values).build();
  // MainシートのB14セルにルールを適用
  ss.getSheetByName("Main").getRange("B14").setDataValidation(rule);
}

（修正部分の説明については別の回答欄に記載しています）

Answer 2

(続き）
修正後のコード全体については、別(上)の回答欄に記載しています。

修正したところとポイント

① チェックボックスの状態を格納する部分

「/*Step8：宛先リストシート名から、シートの内容を配列で取得する」（130行目あたりから）を見ると

function getTargets(recipientListName) {
略
...
......
  const targets = contents.map((row) => {
    return {
      checkbox: [0],               // チェックボックス

となっていました。
この一番下の行の
「checkbox: [0]」
というところを
「checkbox: row[0]」
に修正しています。

おそらく単純ミスではないかな、と思いました。
その下の行では

      to: row[1],                               // 宛先メールアドレス
      cc: row[2],                               // ccアドレス
      bcc: row[3],  

のように、「row[x]」という形になっていますね。

row[0]ではなく[0]としてしまうと、単に数字のゼロが格納されるだけなので、チェックボックスの状態を格納したことになりません。

② チェックボックスを入れた宛先だけを送付させるには？

ご質問の中にある「チェックのついたデータのみを取得できません。」という文から察するに、
質問者さんのコードだと「チェックを入れた行だけメール送信したいのに、全部の行に記入したメールが送信されてしまう。」ということであると推測しました。

そして上に書いた ① の部分を直して試しに「送信」ボタンまたは「下書き」ボタンを押しても、やはり全部送信されてしまいます。

これはなぜかというと「チェックを入れた行だけを送信対象とする」という、条件によるふるい分け処理が欠けているからです。

ではどのようにするかについて説明します。
まず、送信対象を作っている部分は（①で言及したのと同じ） Step8 ： getTargets() 関数の中の、以下の部分になります。（もとのコードのままです）

  const targets = contents.map((row) => {
    return {
      checkbox: row[0],  // [修正]              // チェックボックス
      to: row[1],                               // 宛先メールアドレス
      cc: row[2],                               // ccアドレス
      bcc: row[3],                              // bccアドレス
      replaceList: getReplaceList(header, row), // 置換内容
      eachAttachmentNames: [
        row[14],                                // 個別添付ファイル名１
        row[15],                                // 個別添付ファイル名２
        row[16],                                // 個別添付ファイル名３
      ]
    };
  });

contents.map の「map」 は配列を作る関数です。
「contents」 には、宛先シートの全行データが格納されています。
そこから1行1行取り出して、必要な列だけ格納している処理が、上記のコードの部分です。

では、チェックを付けた行だけに絞るにはどうすればよいでしょうか？

ここで「filter」という関数を使用します。
filter 関数は、配列のうち「条件にあてはまる要素だけ」を抜き出して、新たな配列として返す関数です。
簡単な例で説明します。
たとえば
numbers = [ 1, 2, 3, 4, 5, 6]
という配列があるとして、この配列から、偶数だけを抜き出したいとします。
これをコードで表すと

const numbers = [1, 2, 3, 4, 5, 6];
const new_numbers = numbers.filter(e => e % 2 === 0);
console.log(new_numbers);

>>> [2, 4, 6]
と表示される

となります。
filterの中の「e => e % 2 === 0」というのが条件で「numbersの要素の中で、2で割った余りが0になる数だけを抜き出す」という条件を指定していることになります。

これを応用して、上記の宛先リストのコードに適用すると
「チェックボックスにチェックが入っている（＝チェックボックスの値が true）であるものだけを抜き出す」という条件になります。

これをコードで書くと

  const targets = contents.map((row) => {
    return {
      checkbox: row[0],  // [修正]              // チェックボックス
      to: row[1],                               // 宛先メールアドレス
      cc: row[2],                               // ccアドレス
      bcc: row[3],                              // bccアドレス
      replaceList: getReplaceList(header, row), // 置換内容
      eachAttachmentNames: [
        row[14],                                // 個別添付ファイル名１
        row[15],                                // 個別添付ファイル名２
        row[16],                                // 個別添付ファイル名３
      ]
    };
  }).filter(row => row.checkbox === true);    // [追加]

というようになります。（filter関数の条件を最後に追加）

いったん、contents ＝全行について列を整えた配列を作り、さらにその配列の中から「チェックボックスにチェックが入っている行」だけを抜き出した新たな配列を作る、という処理になります。

Comments

[shirogohan]

まさにやりたかったことを実装することができました！！丁寧に分かりやすく教えてくださり、本当に感謝しています。すごく勉強になりました。ありがとうございました。