GoogleAppsScriptを使ってGmailをSpreadSheetにエクスポートする

2015/03/01 2020/09/07

GoogleAppsScriptを使ってGmailをSpreadSheetにエクスポートする

そのまんまですが、Google Siteから実行出来るようにしました。

https://sites.google.com/site/yamamanx/tools/gmailexporter

動作仕様

受信トレイのメール全てを対象に送信アドレス,受信日時,件名,本文(50,000文字まで)をSpreadSheetに出力します
SpreadSheetは[GmailExport_YYYYMMDDhhmmss]というファイル名でGoogle Driveに新規作成します
出力したメールには[GmailExported]というラベルが作成されて付与されます

コード

もっとこうしたらいい、こうするべきってご意見があるとすごく嬉しく思います。

メイン処理

function gmailExport(){
  var rowNumber = 2;
  var processedLabelName = 'GmailExported';
  var subjectString = 'GmailExport';

  try{
    var threads = GmailApp.getInboxThreads();
    if (threads.length == 0){
      Browser.msgBox('処理終了', '対象のメールがありませんでした。\n終了します。', Browser.Buttons.OK);
      return;
    }

    var mailExportSheet = SpreadsheetApp.create(subjectString + '_' + toOriginalDateString(new Date()));
    var mailSheet = createMailSheet(mailExportSheet,subjectString);

    var processedLabel;
    processedLabel = createProcessedLabel(processedLabelName);

    for (var threadIndex in threads){
      var thread = threads[threadIndex];
      var messages = thread.getMessages();

      for (var messageIndex in messages){

        maxRateAvoid(rowNumber);

        var message = messages[messageIndex];

        var from = message.getFrom();
        var date = message.getDate();
        var subject = message.getSubject();
        var nbsp = String.fromCharCode(160);
        var body = message.getBody().replace(/<("[^"]*"|'[^']*'|[^'">])*>|nbsp/g,'').replace(/&; |　/g,'').substring(1,50000);

        mailSheet.getRange(rowNumber,1).setValue(from);
        mailSheet.getRange(rowNumber,2).setValue(date);
        mailSheet.getRange(rowNumber,3).setValue(subject);
        mailSheet.getRange(rowNumber,4).setValue(body);

        rowNumber++;
      }
      processedLabel.addToThread(thread);
    }
    mailSending((rowNumber - 2) + "通のGmailExportが完了しました。\n" + mailExportSheet.getUrl(),subjectString);
  }catch(e){
    mailSending((rowNumber - 1) + "通目のメールで次のエラーが発生しました。\n" + e.message,subjectString);
  }
};

function gmailExport(){

var rowNumber = 2;

var processedLabelName = 'GmailExported';

var subjectString = 'GmailExport';

try{

var threads = GmailApp.getInboxThreads();

if (threads.length == 0){

Browser.msgBox('処理終了', '対象のメールがありませんでした。\n終了します。', Browser.Buttons.OK);

return;

}

var mailExportSheet = SpreadsheetApp.create(subjectString + '_' + toOriginalDateString(new Date()));

var mailSheet = createMailSheet(mailExportSheet,subjectString);

var processedLabel;

processedLabel = createProcessedLabel(processedLabelName);

for (var threadIndex in threads){

var thread = threads[threadIndex];

var messages = thread.getMessages();

for (var messageIndex in messages){

maxRateAvoid(rowNumber);

var message = messages[messageIndex];

var from = message.getFrom();

var date = message.getDate();

var subject = message.getSubject();

var nbsp = String.fromCharCode(160);

var body = message.getBody().replace(/<("[^"]*"|'[^']*'|[^'">])*>|nbsp/g,'').replace(/&; |　/g,'').substring(1,50000);

mailSheet.getRange(rowNumber,1).setValue(from);

mailSheet.getRange(rowNumber,2).setValue(date);

mailSheet.getRange(rowNumber,3).setValue(subject);

mailSheet.getRange(rowNumber,4).setValue(body);

rowNumber++;

}

processedLabel.addToThread(thread);

}

mailSending((rowNumber - 2) + "通のGmailExportが完了しました。\n" + mailExportSheet.getUrl(),subjectString);

}catch(e){

mailSending((rowNumber - 1) + "通目のメールで次のエラーが発生しました。\n" + e.message,subjectString);

}

};

処理済ラベルの作成

function createProcessedLabel(processedLabelName){
  var processedLabel = GmailApp.getUserLabelByName(processedLabelName);
  if (!processedLabel){
    processedLabel = GmailApp.createLabel(processedLabelName);
  }
  return processedLabel;
};

function createProcessedLabel(processedLabelName){

var processedLabel = GmailApp.getUserLabelByName(processedLabelName);

if (!processedLabel){

processedLabel = GmailApp.createLabel(processedLabelName);

}

return processedLabel;

};

SpreadSheetの作成

function createMailSheet(mailExportSheet,subjectString){
  var mailSheet = mailExportSheet.getSheets()[0];
  mailSheet.setName(subjectString);
  mailSheet.getRange(1,1).setValue("From");
  mailSheet.getRange(1,2).setValue("DateTime");
  mailSheet.getRange(1,3).setValue("Subject");
  mailSheet.getRange(1,4).setValue("Body");

  return mailSheet;
};

function createMailSheet(mailExportSheet,subjectString){

var mailSheet = mailExportSheet.getSheets()[0];

mailSheet.setName(subjectString);

mailSheet.getRange(1,1).setValue("From");

mailSheet.getRange(1,2).setValue("DateTime");

mailSheet.getRange(1,3).setValue("Subject");

mailSheet.getRange(1,4).setValue("Body");

return mailSheet;

};

Gmailのmax rate対応

function maxRateAvoid(rowNumber){
  if (rowNumber >= 90 && rowNumber%90 == 0){
    Utilities.sleep(100000);
  }else{
    Utilities.sleep(1000);
  }
};

function maxRateAvoid(rowNumber){

if (rowNumber >= 90 && rowNumber%90 == 0){

Utilities.sleep(100000);

}else{

Utilities.sleep(1000);

}

};

結果のメール送信

function mailSending(messageString,subjectString){
  var user = Session.getActiveUser();
  if (user){
    try{
      MailApp.sendEmail(user.getEmail(),subjectString,messageString);
    }catch(e){
      Logger.log(e.message);
    }
  }
};

function mailSending(messageString,subjectString){

var user = Session.getActiveUser();

if (user){

try{

MailApp.sendEmail(user.getEmail(),subjectString,messageString);

}catch(e){

Logger.log(e.message);

}

};

ブラウザ非依存日付文字列生成

function toOriginalDateString(date){
  return date.getFullYear().toString()
  + date.getMonth().toString()
  + date.getDate().toString()
  + date.getHours().toString()
  + date.getMinutes().toString()
  + date.getSeconds().toString();
};

function toOriginalDateString(date){

return date.getFullYear().toString()

+ date.getMonth().toString()

+ date.getDate().toString()

+ date.getHours().toString()

+ date.getMinutes().toString()

+ date.getSeconds().toString();

};

コード解説

gmailExport

var threads = GmailApp.getInboxThreads();
if (threads.length == 0){
      Browser.msgBox('処理終了', '対象のメールがありませんでした。\n終了します。', Browser.Buttons.OK);
      return;
}

var threads = GmailApp.getInboxThreads();

if (threads.length == 0){

Browser.msgBox('処理終了', '対象のメールがありませんでした。\n終了します。', Browser.Buttons.OK);

return;

}

GmailAppのgetInboxThreads()メソッドでメールスレッドを取得。
0件の場合スレッド配列オブジェクトは出来るのでlengthプロパティで確認。

var mailExportSheet = SpreadsheetApp.create(subjectString + '_' + toOriginalDateString(new Date()));

1 2	var mailExportSheet = SpreadsheetApp.create(subjectString + '_' + toOriginalDateString(new Date()));

SpreadSheetAppクラスのcreate(ファイル名)メソッドで新規SpreadSheetを作成。

for (var threadIndex in threads){
      var thread = threads[threadIndex];
      var messages = thread.getMessages();

      for (var messageIndex in messages){

        maxRateAvoid(rowNumber);

        var message = messages[messageIndex];

for (var threadIndex in threads){

var thread = threads[threadIndex];

var messages = thread.getMessages();

for (var messageIndex in messages){

maxRateAvoid(rowNumber);

var message = messages[messageIndex];

スレッド配列のループでスレッドメッセージ配列を取得。
スレッドメッセージ配列のループでメッセージオブジェクトを取得。
maxRateAvoidは後述。

var from = message.getFrom();
var date = message.getDate();
var subject = message.getSubject();
var nbsp = String.fromCharCode(160);
var body = message.getBody().replace(/<("[^"]*"|'[^']*'|[^'">])*>|nbsp/g,'').replace(/&; |　/g,'').substring(1,50000);

var from = message.getFrom();

var date = message.getDate();

var subject = message.getSubject();

var nbsp = String.fromCharCode(160);

var body = message.getBody().replace(/<("[^"]*"|'[^']*'|[^'">])*>|nbsp/g,'').replace(/&; |　/g,'').substring(1,50000);

MessageクラスのgetFrom(),getDate(),getSubject(),getBody()で各要素にアクセス。
除去のためString.fromCharCode(160)でreplace対象を生成。
あわせてreplace(/<(“[^”]“|'[^’]‘|[^'”>])*>|nbsp/g,”)でHTMLタグも除去。
SpreadSheetのセルの限界文字列数50,000文字に切り取り。

mailSheet.getRange(rowNumber,1).setValue(from);
mailSheet.getRange(rowNumber,2).setValue(date);
mailSheet.getRange(rowNumber,3).setValue(subject);
mailSheet.getRange(rowNumber,4).setValue(body);

mailSheet.getRange(rowNumber,1).setValue(from);

mailSheet.getRange(rowNumber,2).setValue(date);

mailSheet.getRange(rowNumber,3).setValue(subject);

mailSheet.getRange(rowNumber,4).setValue(body);

各変数に入れたメール要素の文字列をセルに格納。

processedLabel.addToThread(thread);

1 2	processedLabel.addToThread(thread);

処理済のメールにラベルを付与する。

createProcessedLabel

var processedLabel = GmailApp.getUserLabelByName(processedLabelName);
if (!processedLabel){
　processedLabel = GmailApp.createLabel(processedLabelName);
}

var processedLabel = GmailApp.getUserLabelByName(processedLabelName);

if (!processedLabel){

　processedLabel = GmailApp.createLabel(processedLabelName);

}

GmailAppクラスのgetUserLabelByName(ラベル名)メソッドでラベルの有無を判定。
なければGmailAppクラスのcreateLabel(ラベル名)メソッドでラベルを作成。

createMailSheet(の作成

var mailSheet = mailExportSheet.getSheets()[0];
mailSheet.setName(subjectString);
mailSheet.getRange(1,1).setValue("From");
mailSheet.getRange(1,2).setValue("DateTime");
mailSheet.getRange(1,3).setValue("Subject");
mailSheet.getRange(1,4).setValue("Body");

var mailSheet = mailExportSheet.getSheets()[0];

mailSheet.setName(subjectString);

mailSheet.getRange(1,1).setValue("From");

mailSheet.getRange(1,2).setValue("DateTime");

mailSheet.getRange(1,3).setValue("Subject");

mailSheet.getRange(1,4).setValue("Body");

1つ目のシートにシート名を設定して1列目にタイトル行を作成。

maxRateAvoid

if (rowNumber >= 90 && rowNumber%90 == 0){
 Utilities.sleep(100000);
}else{
 Utilities.sleep(1000);
}

if (rowNumber >= 90 && rowNumber%90 == 0){

Utilities.sleep(100000);

}else{

Utilities.sleep(1000);

}

max rateにひっかかるからsleepしなさいってエラーが発生するので、ループ1回につき1秒待つ。
それでも90メールを超えるとエラーが発生するので90メールごとに100秒待つ。

mailSending

var user = Session.getActiveUser();
if (user){
 try{
  MailApp.sendEmail(user.getEmail(),subjectString,messageString);
 }catch(e){
  Logger.log(e.message);
 }
}

var user = Session.getActiveUser();

if (user){

try{

MailApp.sendEmail(user.getEmail(),subjectString,messageString);

}catch(e){

Logger.log(e.message);

}

ログインユーザのオブジェクトをSessionクラスのgetActiveUser()メソッドで取得。
MailAppクラスのsendEmail(宛先,件名,本文)メソッドで送信。
スクリプトを作成したユーザと別ドメインのユーザではgetActiveUser()で何も帰らないようです。
メールアドレスとかを悪用出来ないようにしているのでしょうね。
今回はこのスクリプトをgmail.comユーザで作成しているのですが、
という事は同じAppsドメインなら同じ組織だからいいけど、
gmail.com同士はきっと他人だからだめなんでしょうね。

toOriginalDateString

return date.getFullYear().toString()
  + date.getMonth().toString()
  + date.getDate().toString()
  + date.getHours().toString()
  + date.getMinutes().toString()
  + date.getSeconds().toString();