Class GmailApp

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

// The code below creates a draft email with the current date and time.
var now = new Date();
GmailApp.createDraft("[email protected]", "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('[email protected]', '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/

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

この呼び出しは、すべてのスレッドのサイズが大きすぎてシステムで処理できない場合に失敗します。 スレッドサイズが不明で、非常に大きい可能性がある場合は、"paged"呼び出し、 各呼び出しで取得するスレッドの範囲を指定します。

// 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)

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

この呼び出しは、すべてのスレッドのサイズが大きすぎてシステムで処理できない場合に失敗します。 スレッドサイズが不明で、非常に大きい可能性がある場合は、"paged"呼び出し、 各呼び出しで取得するスレッドの範囲を指定します。

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/

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

この呼び出しは、すべてのスレッドのサイズが大きすぎてシステムで処理できない場合に失敗します。 スレッドサイズが不明で、非常に大きい可能性がある場合は、"paged"呼び出し、 各呼び出しで取得するスレッドの範囲を指定します。

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/

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

この呼び出しは、すべてのスレッドのサイズが大きすぎてシステムで処理できない場合に失敗します。 スレッドサイズが不明で、非常に大きい可能性がある場合は、"paged"呼び出し、 各呼び出しで取得するスレッドの範囲を指定します。

// 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)

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

この呼び出しは、すべてのスレッドのサイズが大きすぎてシステムで処理できない場合に失敗します。 スレッドサイズが不明で、非常に大きい可能性がある場合は、"paged"呼び出し、 各呼び出しで取得するスレッドの範囲を指定します。

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 を検索します。

この呼び出しは、すべてのスレッドのサイズが大きすぎてシステムで処理できない場合に失敗します。 スレッドサイズが不明で、非常に大きい可能性がある場合は、"paged"呼び出し、 各呼び出しで取得するスレッドの範囲を指定します。

// 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("[email protected]", "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('[email protected]', '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)