Class GmailApp

メールの下書きを作成します。メールのサイズ（ヘッダーを含む）には割り当てが制限されています。

// The code below creates a draft email with the current date and time.
var now = new Date();
GmailApp.createDraft("mike@example.com", "current time", "The time is: " + now.toString());

パラメータ

リターン

GmailDraft - 新しく作成された GmailDraft

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• createDraft(recipient, subject, body, options)

オプションの引数を指定して、メールの下書きを作成します。メールには書式なしテキストまたは HTML 本文を含めることができます。メールのサイズ（ヘッダーを含むが、添付ファイルは除く）は割り当て制限ありです。

// Create a draft email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft('mike@example.com', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

パラメータ

拡張パラメータ

リターン

GmailDraft - 新しく作成された GmailDraft

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• createDraft(recipient, subject, body)

指定した名前の新しいユーザーラベルを作成します。

// Creates the label @FOO and logs label: FOO
Logger.log("label: " + GmailApp.createLabel("FOO"));

パラメータ

リターン

GmailLabel - 新しく作成されたラベル

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• deleteLabel(label)

指定したラベルを削除します。

// Have to get the label by name first
var label = GmailApp.getUserLabelByName("FOO");
GmailApp.deleteLabel(label);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• createLabel(name)

Gmail でこのアカウントのエイリアスとして設定されているメールのリストを取得します。

オプションの引数「from」を使用すると、これらのエイリアスからメッセージを送信できます。

// Log the aliases for this Gmail account and send an email as the first one.
var me = Session.getActiveUser().getEmail();
var aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]});
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

リターン

String[] - このアカウントのエイリアスの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• sendEmail(recipient, subject, body, options)

ID でメールの下書きを取得します。

Gmail の下書きでは getId() と組み合わせて使用します。

// Get the first draft message in your drafts folder
var draft = GmailApp.getDrafts()[0];
// Get its ID
var draftId = draft.getId();
// Now fetch the same draft using that ID.
var draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());

パラメータ

リターン

GmailDraft - 指定された ID のドラフト

例外

Error - 指定された ID の下書きが見つからない場合

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

すべての下書きメッセージを取得します。

// Logs the number of draft messages
var drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

リターン

GmailMessage[] - Gmail の下書きメッセージの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

Gmail の下書きメールをすべて取得します。

var drafts = GmailApp.getDrafts();
for (var i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

リターン

GmailDraft[] - Gmail の下書きメールの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

ラベルに関係なく、受信トレイのすべてのスレッドを取得します。

すべてのスレッドのサイズが大きすぎてシステムで処理できない場合、この呼び出しは失敗します。スレッドサイズが不明で、非常に大きくなる可能性がある場合は、「ページング」呼び出しを使用して、各呼び出しで取得するスレッドの範囲を指定してください。

// Log the subject lines of your Inbox
var threads = GmailApp.getInboxThreads();
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

リターン

GmailThread[] - 受信トレイ内の Gmail スレッドの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

ラベルに関係なく、受信トレイのスレッドの範囲を取得します。

// Log the subject lines of up to the first 50 emails in your Inbox
var threads = GmailApp.getInboxThreads(0, 50);
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

パラメータ

リターン

GmailThread[] - 受信トレイ内の Gmail スレッドの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

受信トレイ内の未読スレッドの数を取得します。

Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());

リターン

Integer - 受信トレイ内に未読メッセージがあるスレッドの数

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

ID でメッセージを取得します。

Gmail のメールでは getId() と組み合わせて使用します。

// Get the first message in the first thread of your inbox
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
var messageId = message.getId();
// Now fetch the same message using that ID.
var messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() == messageById.getSubject());

パラメータ

リターン

GmailMessage - 指定された ID を持つメッセージ

例外

Error - 指定された ID を持つメッセージが見つからない場合

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• getThreadById(id)

指定したスレッドのすべてのメッセージを取得します。

// Log all the subject lines in the first thread of your inbox
var thread = GmailApp.getInboxThreads(0, 1)[0];
var messages = GmailApp.getMessagesForThread(thread);
for (var i = 0 ; i < messages.length; i++) {
  Logger.log("subject: " + messages[i].getSubject());
}

パラメータ

リターン

GmailMessage[] - このスレッドに対応するメッセージの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• getMessagesForThreads(threads)

指定したスレッドのすべてのメッセージを取得します。

// Log the subject lines of all messages in the first two threads of your inbox
var thread = GmailApp.getInboxThreads(0, 2);
var messages = GmailApp.getMessagesForThreads(thread);
for (var i = 0 ; i < messages.length; i++) {
  for (var j = 0; j < messages[i].length; j++) {
    Logger.log("subject: " + messages[i][j].getSubject());
  }
}

パラメータ

リターン

GmailMessage[][] - メッセージの配列。外部配列の各項目はスレッドに対応し、内部配列にはそのスレッドのメッセージが含まれます。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• getMessagesForThread(thread)

ラベルに関係なく、優先トレイのすべてのスレッドを取得します。

すべてのスレッドのサイズが大きすぎてシステムで処理できない場合、この呼び出しは失敗します。スレッドサイズが不明で、非常に大きくなる可能性がある場合は、「ページング」呼び出しを使用して、各呼び出しで取得するスレッドの範囲を指定してください。

Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads().length);

リターン

GmailThread[] - 優先トレイにある Gmail スレッドの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

ラベルに関係なく、優先トレイのスレッドの範囲を取得します。

// Will log some number 2 or less
Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads(0, 2).length);

パラメータ

リターン

GmailThread[] - 優先トレイにある Gmail スレッドの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

優先トレイ内の未読スレッドの数を取得します。

Logger.log("Number of unread emails in your Priority Inbox : " +
           GmailApp.getPriorityInboxUnreadCount());

リターン

Integer - 優先トレイ内の未読メールがあるスレッドの数

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

ラベルに関係なく、すべてのスパムスレッドを取得します。

すべてのスレッドのサイズが大きすぎてシステムで処理できない場合、この呼び出しは失敗します。スレッドサイズが不明で、非常に大きくなる可能性がある場合は、「ページング」呼び出しを使用して、各呼び出しで取得するスレッドの範囲を指定してください。

Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);

リターン

GmailThread[] - 迷惑メールフォルダ内の Gmail スレッドの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

ラベルに関係なく、一連のスパムスレッドを取得します。

// Will log a number at most 5
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads(0, 5).length);

パラメータ

リターン

GmailThread[] - 迷惑メールフォルダ内の Gmail スレッドの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

スパムである未読スレッドの数を取得します。

// Unless you actually read stuff in your spam folder, this should be the same as
// the number of messages in your spam folder.
Logger.log("# unread threads that are spam: " + GmailApp.getSpamUnreadCount());

リターン

Integer - 未読メッセージがあるスパムスレッドの数

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

ラベルに関係なく、スター付きのスレッドをすべて取得します。

すべてのスレッドのサイズが大きすぎてシステムで処理できない場合、この呼び出しは失敗します。スレッドサイズが不明で、非常に大きくなる可能性がある場合は、「ページング」呼び出しを使用して、各呼び出しで取得するスレッドの範囲を指定してください。

// Logs the number of starred threads
Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);

リターン

GmailThread[] - スター付きの Gmail スレッドの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

ラベルに関係なく、スター付きのスレッドの範囲を取得します。

// Logs the number of starred threads to a maximum of 5
Logger.log("# Starred threads: " + GmailApp.getStarredThreads(0, 5).length);

パラメータ

リターン

GmailThread[] - スター付きの Gmail スレッドの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

スター付きの未読スレッドの数を取得します。

Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());

リターン

Integer - 未読メッセージがあるスター付きスレッドの数

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

ID でスレッドを取得します。

Gmail スレッドでは getId() と組み合わせて使用します。

// Gets the first inbox thread.
const firstThread = GmailApp.getInboxThreads(0,1)[0];
// Gets the same thread by ID.
const threadById = GmailApp.getThreadById(firstThread.getId());
// Verifies that they are the same.
console.log(firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject());

パラメータ

リターン

GmailThread - 指定された ID を持つスレッド、または見つからない場合は null を持つスレッド。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• getMessageById(id)

ラベルに関係なく、ゴミ箱のすべてのスレッドを取得します。

すべてのスレッドのサイズが大きすぎてシステムで処理できない場合、この呼び出しは失敗します。スレッドサイズが不明で、非常に大きくなる可能性がある場合は、「ページング」呼び出しを使用して、各呼び出しで取得するスレッドの範囲を指定してください。

Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);

リターン

GmailThread[] - ゴミ箱内の Gmail スレッドの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

ラベルに関係なく、ゴミ箱スレッドの範囲を取得します。

// Will log a number at most 5
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);

パラメータ

リターン

GmailThread[] - ゴミ箱内の Gmail スレッドの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

指定したラベル名のラベルを取得します。

var labelObject = GmailApp.getUserLabelByName("myLabel");

パラメータ

リターン

GmailLabel - 指定した名前の Gmail ラベル

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

ユーザーが作成したラベルのリストを取得します。

// Logs all of the names of your labels
var labels = GmailApp.getUserLabels();
for (var i = 0; i < labels.length; i++) {
  Logger.log("label: " + labels[i].getName());
}

リターン

GmailLabel[] - ユーザーが作成したラベルの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

このメッセージを既読にし、メッセージを強制的に更新します。

// Mark the first message in the first thread of your inbox as read
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• markMessageUnread(message)

このメッセージを未読にして、強制的に更新します。

// Mark the first message in the first thread of your inbox as unread
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• markMessageRead(message)

該当するメッセージを既読にし、強制的に更新します。

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(thread.getMessages());

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• markMessagesUnread(messages)

これらのメールを未読にして、強制的に更新します。

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(thread.getMessages());

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• markMessagesRead(messages)

このスレッドに重要マークを付けて、スレッドを強制的に更新します。

// Marks first inbox thread as important
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• markThreadUnimportant(thread)

このスレッドを既読としてマークし、スレッドを強制的に更新します。

// Marks first inbox thread as read
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• markThreadUnread(thread)

このスレッドを重要でないものとしてマークし、スレッドを強制的に更新します。

// Marks first inbox thread as unimportant
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• markThreadImportant(thread)

このスレッドを未読にして、スレッドを強制的に更新します。

// Marks first inbox thread as unread
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• markThreadRead(thread)

これらのスレッドに重要マークを付けて、スレッドを強制的に更新します。

// Marks first two threads in inbox as important
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• markThreadsUnimportant(threads)

これらのスレッドを既読としてマークし、スレッドを強制的に更新します。

// Marks first two threads in inbox as read
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• markThreadsUnread(threads)

これらのスレッドを重要でないものとしてマークし、スレッドを強制的に更新します。

// Marks first two threads in inbox as unimportant
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• markThreadsImportant(threads)

これらのスレッドを未読としてマークし、スレッドを強制的に更新します。

// Marks first two threads in inbox as unread
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• markThreadsRead(threads)

メッセージをゴミ箱に移動し、強制的に更新します。

// Move the first message in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

パラメータ

リターン

GmailApp - Gmail サービス（チェーンに便利です）

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• moveMessagesToTrash(messages)

指定したメッセージをゴミ箱に移動し、強制的に更新します。

// Move first two messages in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var messages = firstThread.getMessages();
var toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

パラメータ

リターン

GmailApp - Gmail サービス（チェーンに便利です）

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• moveMessageToTrash(message)

このスレッドをアーカイブに移動し、強制的に更新します。

// Archive the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToArchive(firstThread);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToTrash(thread)

このスレッドを受信トレイに移動し、強制的に更新します。

// Find a thread not already in your inbox
var thread = GmailApp.search("-in:inbox")[0]; // Get the first one
GmailApp.moveThreadToInbox(thread);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• moveThreadToTrash(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

このスレッドを [スパム] に移動し、スレッドを強制的に更新します。

// Tag first thread in inbox as spam
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToSpam(firstThread);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• moveThreadToTrash(thread)
• moveThreadToInbox(thread)
• moveThreadToArchive(thread)

このスレッドをゴミ箱に移動して、スレッドを強制的に更新します。

// Move first thread in inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToTrash(firstThread);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

これらのスレッドをアーカイブに移動し、強制的に更新します。

// Move first two threads in your inbox to the archive
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToTrash(threads)

これらのスレッドを受信トレイに移動し、強制的に更新します。

// Find two threads not already in your inbox
var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• moveThreadsToTrash(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

これらのスレッドをスパムに移動し、強制的に更新します。

// Move first two threads in your inbox to spam
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• moveThreadsToInbox(threads)
• moveThreadsToTrash(threads)
• moveThreadsToArchive(threads)

これらのスレッドをゴミ箱に移動し、強制的に更新します。

// Move first two threads in your inbox to trash
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

Gmail からメールとそれに関連付けられている状態を再読み込みします（ラベルや既読状態などが変更された場合に役立ちます）。

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• refreshMessages(messages)

Gmail からメッセージと関連する状態を再読み込みします（ラベルや既読状態などが変更された場合に役立ちます）。

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• refreshMessage(message)

Gmail からスレッドと関連する状態を再読み込みします（ラベルや読み取り状態などが変更された場合に役立ちます）。

var firstThread = GmailApp.getInboxThreads(0,1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• refreshThreads(threads)

Gmail からスレッドと関連する状態を再読み込みします（ラベルや読み取り状態などが変更された場合に役立ちます）。

var threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• refreshThread(thread)

指定されたクエリで Gmail を検索します。

すべてのスレッドのサイズが大きすぎてシステムで処理できない場合、この呼び出しは失敗します。スレッドサイズが不明で、非常に大きくなる可能性がある場合は、「ページング」呼び出しを使用して、各呼び出しで取得するスレッドの範囲を指定してください。

// Find starred messages with subject IMPORTANT
var threads = GmailApp.search('is:starred subject:"IMPORTANT"');

パラメータ

リターン

GmailThread[] - このクエリに一致する Gmail スレッドの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

指定されたクエリで Gmail を検索します。

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty array.
var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

パラメータ

リターン

GmailThread[] - このクエリに一致する Gmail スレッドの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

メール メッセージを送信します。メールのサイズ（ヘッダーを含む）には割り当てが制限されています。

// The code below will send an email with the current date and time.
var now = new Date();
GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• sendEmail(recipient, subject, body, options)

オプションの引数を指定してメール メッセージを送信します。メールには書式なしテキストまたは HTML 本文を含めることができます。メールのサイズ（ヘッダーを含むが、添付ファイルは除く）は割り当て制限ありです。

// Send an email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail('mike@example.com', 'Attachment example', 'Please see the attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

パラメータ

拡張パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• sendEmail(recipient, subject, body)

現在のメッセージ アクセス トークンを設定して、スクリプトが現在の GmailMessage プロパティにアクセスできるようにします。

この方法が必要なのは、Gmail の現在のメッセージ スコープを使用する Google Workspace アドオン プロジェクトのみです。

function handleAddonActionEvent(e) {
  var accessToken = e.messageMetadata.accessToken;
  var messageId = e.messageMetadata.messageId;
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  // Do something with mailMessage
}

パラメータ

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

このメッセージにスターを付けて、メッセージを強制的に更新します。

// Stars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• starMessages(messages)

該当するメッセージにスターを付けて、メッセージを強制的に更新します。

// Stars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• starMessage(message)

このメッセージからスターをはずして、メッセージを強制的に更新します。

// Unstars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• unstarMessages(messages)

該当するメッセージからスターを削除して、メッセージを強制的に更新します。

// Unstars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

パラメータ

リターン

GmailApp - Gmail サービス。チェーン接続に便利です。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。

• https://mail.google.com/

関連ドキュメント

• unstarMessage(message)