Class GmailApp

GmailApp

Gmail のスレッド、メッセージ、ラベルへのアクセスを提供します。

メソッド

メソッド戻り値の型概要
createDraft(recipient, subject, body)GmailDraftメール メッセージの下書きを作成します。
createDraft(recipient, subject, body, options)GmailDraft省略可能な引数を使用して、メール メッセージの下書きを作成します。
createLabel(name)GmailLabel指定された名前の新しいユーザーラベルを作成します。
deleteLabel(label)GmailApp指定されたラベルを削除します。
getAliases()String[]Gmail でこのアカウントのエイリアスとして設定されているメールのリストを取得します。
getDraft(draftId)GmailDraftID でメール メッセージの下書きを取得します。
getDraftMessages()GmailMessage[]すべての下書きメッセージを取得します。
getDrafts()GmailDraft[]すべての Gmail 下書きメールを取得します。
getInboxThreads()GmailThread[]ラベルに関係なく、受信トレイのすべてのスレッドを取得します。
getInboxThreads(start, max)GmailThread[]ラベルに関係なく、受信トレイのスレッドの範囲を取得します。
getInboxUnreadCount()Integer受信トレイ内の未読スレッドの数を取得します。
getMessageById(id)GmailMessageID でメッセージを取得します。
getMessagesForThread(thread)GmailMessage[]指定されたスレッド内のすべてのメッセージを取得します。
getMessagesForThreads(threads)GmailMessage[][]指定されたスレッド内のすべてのメッセージを取得します。
getPriorityInboxThreads()GmailThread[]ラベルに関係なく、優先トレイのすべてのスレッドを取得します。
getPriorityInboxThreads(start, max)GmailThread[]ラベルに関係なく、優先トレイのスレッドの範囲を取得します。
getPriorityInboxUnreadCount()Integer優先トレイ内の未読スレッドの数を取得します。
getSpamThreads()GmailThread[]ラベルに関係なく、すべてのスパム スレッドを取得します。
getSpamThreads(start, max)GmailThread[]ラベルに関係なく、スパム スレッドの範囲を取得します。
getSpamUnreadCount()Integer迷惑メールの未読スレッドの数を取得します。
getStarredThreads()GmailThread[]ラベルに関係なく、スター付きのすべてのスレッドを取得します。
getStarredThreads(start, max)GmailThread[]ラベルに関係なく、スター付きスレッドの範囲を取得します。
getStarredUnreadCount()Integerスター付きの未読スレッドの数を取得します。
getThreadById(id)GmailThread|nullID でスレッドを取得します。
getTrashThreads()GmailThread[]ラベルに関係なく、すべてのゴミ箱スレッドを取得します。
getTrashThreads(start, max)GmailThread[]ラベルに関係なく、ゴミ箱内のスレッドの範囲を取得します。
getUserLabelByName(name)GmailLabelラベル名で指定されたラベルを取得します。
getUserLabels()GmailLabel[]ユーザーが作成したラベルのリストを取得します。
markMessageRead(message)GmailAppこのメッセージを既読にし、メッセージを強制的に更新します。
markMessageUnread(message)GmailAppこのメッセージを未読としてマークし、メッセージを強制的に更新します。
markMessagesRead(messages)GmailAppこれらのメッセージを既読にし、メッセージを強制的に更新します。
markMessagesUnread(messages)GmailAppこれらのメッセージを未読としてマークし、メッセージを強制的に更新します。
markThreadImportant(thread)GmailAppこのスレッドに重要マークを付け、スレッドを強制的に更新します。
markThreadRead(thread)GmailAppこのスレッドを既読にし、スレッドを強制的に更新します。
markThreadUnimportant(thread)GmailAppこのスレッドを重要でないとマークし、スレッドを強制的に更新します。
markThreadUnread(thread)GmailAppこのスレッドを未読としてマークし、スレッドを強制的に更新します。
markThreadsImportant(threads)GmailAppこれらのスレッドに重要マークを付け、スレッドを強制的に更新します。
markThreadsRead(threads)GmailAppこれらのスレッドを既読にし、スレッドを強制的に更新します。
markThreadsUnimportant(threads)GmailAppこれらのスレッドを重要でないとマークし、スレッドを強制的に更新します。
markThreadsUnread(threads)GmailAppこれらのスレッドを未読としてマークし、スレッドを強制的に更新します。
moveMessageToTrash(message)GmailAppメールをゴミ箱に移動し、メールを強制的に更新します。
moveMessagesToTrash(messages)GmailApp指定されたメッセージをゴミ箱に移動し、メッセージの更新を強制します。
moveThreadToArchive(thread)GmailAppこのスレッドをアーカイブに移動し、スレッドを強制的に更新します。
moveThreadToInbox(thread)GmailAppこのスレッドを受信トレイに移動し、スレッドを強制的に更新します。
moveThreadToSpam(thread)GmailAppこのスレッドをスパムに移動し、スレッドを強制的に更新します。
moveThreadToTrash(thread)GmailAppこのスレッドをゴミ箱に移動し、スレッドを強制的に更新します。
moveThreadsToArchive(threads)GmailAppこれらのスレッドをアーカイブに移動し、スレッドを強制的に更新します。
moveThreadsToInbox(threads)GmailAppこれらのスレッドを受信トレイに移動し、スレッドを強制的に更新します。
moveThreadsToSpam(threads)GmailAppこれらのスレッドをスパムに移動し、スレッドを強制的に更新します。
moveThreadsToTrash(threads)GmailAppこれらのスレッドをゴミ箱に移動し、スレッドを強制的に更新します。
refreshMessage(message)GmailAppGmail からメッセージと関連する状態を再読み込みします（ラベルや既読状態などが変更された場合に便利です）。
refreshMessages(messages)GmailAppGmail からメッセージと関連する状態を再読み込みします（ラベルや既読状態などが変更された場合に便利です）。
refreshThread(thread)GmailAppGmail からスレッドと関連する状態を再読み込みします（ラベルや既読状態などが変更された場合に便利です）。
refreshThreads(threads)GmailAppGmail からスレッドと関連する状態を再読み込みします（ラベルや既読状態などが変更された場合に便利です）。
search(query)GmailThread[]指定されたクエリで Gmail を検索します。
search(query, start, max)GmailThread[]指定されたクエリで Gmail を検索します。
sendEmail(recipient, subject, body)GmailAppメール メッセージを送信します。
sendEmail(recipient, subject, body, options)GmailApp省略可能な引数を使用してメール メッセージを送信します。
setCurrentMessageAccessToken(accessToken)voidスクリプトが現在の GmailMessage プロパティにアクセスできるようにする現在のメッセージ アクセス トークンを設定します。
starMessage(message)GmailAppこのメッセージにスターを付け、メッセージを強制的に更新します。
starMessages(messages)GmailAppこれらのメッセージにスターを追加し、メッセージを強制的に更新します。
unstarMessage(message)GmailAppこのメッセージからスターを削除し、メッセージを強制的に更新します。
unstarMessages(messages)GmailAppこれらのメッセージからスターを削除し、メッセージを強制的に更新します。

詳細なドキュメント

createDraft(recipient, subject, body)

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

// The code below creates a draft email with the current date and time.
const now = new Date();
GmailApp.createDraft(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

パラメータ

名前タイプ説明
recipientStringメールアドレスのカンマ区切りのリスト
subjectStringメールの件名
bodyStringメールの本文

戻る

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.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft(
    'mike@example.com',
    'Attachment example',
    'Please see attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

パラメータ

名前タイプ説明
recipientString受信者のアドレス
subjectString件名
bodyStringメールの本文
optionsObject高度なパラメータを指定する JavaScript オブジェクト（以下を参照）

高度なパラメータ

名前タイプ説明
attachmentsBlobSource[]メールで送信するファイルの配列
bccStringBCC に追加するメールアドレスのカンマ区切りのリスト
ccStringCC に追加するメールアドレスのカンマ区切りのリスト
fromStringメールの送信元アドレス。getAliases() によって返される値のいずれかである必要があります。
htmlBodyString設定されている場合、HTML をレンダリングできるデバイスは、必須の本文引数の代わりにこれを使用します。メールにインライン画像がある場合は、HTML 本文にオプションの inlineImages フィールドを追加できます。
inlineImagesObject画像キー（String）から画像データ（BlobSource）へのマッピングを含む JavaScript オブジェクト。これは、htmlBody パラメータが使用され、これらの画像への参照が <img src="cid:imageKey" /> 形式で含まれていることを前提としています。
nameStringメールの送信者の名前（デフォルト: ユーザーの名前）
replyToStringデフォルトの返信先アドレスとして使用するメールアドレス （デフォルト: ユーザーのメールアドレス）

戻る

GmailDraft - 新しく作成された GmailDraft

承認

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

  • https://mail.google.com/

関連情報

createLabel(name)

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

// Creates the label @FOO and logs label: FOO
Logger.log(`label: ${GmailApp.createLabel('FOO')}`);

パラメータ

名前タイプ説明
nameString新しいラベルの名前

戻る

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

承認

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

  • https://mail.google.com/

関連情報

deleteLabel(label)

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

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

パラメータ

名前タイプ説明
labelGmailLabel削除するラベル

戻る

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

承認

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

  • https://mail.google.com/

関連情報

getAliases()

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

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

// Log the aliases for this Gmail account and send an email as the first one.
const me = Session.getActiveUser().getEmail();
const 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/

関連情報

getDraft(draftId)

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

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

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

パラメータ

名前タイプ説明
draftIdString取得する下書きの ID

戻る

GmailDraft - 指定された ID の下書き

例外

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

承認

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

  • https://mail.google.com/

getDraftMessages()

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

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

戻る

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

承認

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

  • https://mail.google.com/

getDrafts()

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

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

戻る

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

承認

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

  • https://mail.google.com/

getInboxThreads()

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

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

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

戻る

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

承認

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

  • https://mail.google.com/

getInboxThreads(start, max)

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

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

パラメータ

名前タイプ説明
startInteger取得する最初のスレッドのインデックス
maxInteger取得するスレッドの最大数

戻る

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

承認

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

  • https://mail.google.com/

getInboxUnreadCount()

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

Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`);

戻る

Integer - 受信トレイ内の未読メッセージを含むスレッドの数

承認

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

  • https://mail.google.com/

getMessageById(id)

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

Gmail メッセージの getId() と組み合わせて使用します。

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

パラメータ

名前タイプ説明
idString取得するメッセージの ID

戻る

GmailMessage - 指定された ID のメッセージ

例外

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

承認

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

  • https://mail.google.com/

関連情報

getMessagesForThread(thread)

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

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

パラメータ

名前タイプ説明
threadGmailThread取得するメッセージのスレッド

戻る

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
const thread = GmailApp.getInboxThreads(0, 2);
const messages = GmailApp.getMessagesForThreads(thread);
for (let i = 0; i < messages.length; i++) {
  for (let j = 0; j < messages[i].length; j++) {
    Logger.log(`subject: ${messages[i][j].getSubject()}`);
  }
}

パラメータ

名前タイプ説明
threadsGmailThread[]取得するメッセージのスレッド

戻る

GmailMessage[][] - メッセージの配列の配列。外側の配列の各アイテムはスレッドに対応し、内側の配列にはそのスレッドのメッセージが含まれます。

承認

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

  • https://mail.google.com/

関連情報

getPriorityInboxThreads()

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

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

Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads().length}`,
);

戻る

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

承認

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

  • https://mail.google.com/

getPriorityInboxThreads(start, max)

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

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

パラメータ

名前タイプ説明
startInteger取得する最初のスレッドのインデックス
maxInteger取得するスレッドの最大数

戻る

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

承認

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

  • https://mail.google.com/

getPriorityInboxUnreadCount()

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

Logger.log(
    `Number of unread emails in your Priority Inbox : ${
        GmailApp.getPriorityInboxUnreadCount()}`,
);

戻る

Integer - 優先トレイ内の未読メッセージを含むスレッドの数

承認

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

  • https://mail.google.com/

getSpamThreads()

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

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

Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads().length}`);

戻る

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

承認

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

  • https://mail.google.com/

getSpamThreads(start, max)

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

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

パラメータ

名前タイプ説明
startInteger取得する最初のスレッドのインデックス
maxInteger取得するスレッドの最大数

戻る

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

承認

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

  • https://mail.google.com/

getSpamUnreadCount()

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

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

getStarredThreads()

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

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

// Logs the number of starred threads
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`);

戻る

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

承認

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

  • https://mail.google.com/

getStarredThreads(start, max)

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

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

パラメータ

名前タイプ説明
startInteger取得する最初のスレッドのインデックス
maxInteger取得するスレッドの最大数

戻る

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

承認

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

  • https://mail.google.com/

getStarredUnreadCount()

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

Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`);

戻る

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

承認

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

  • https://mail.google.com/

getThreadById(id)

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(),
);

パラメータ

名前タイプ説明
idString取得するスレッドの ID。

戻る

GmailThread|null - 指定された ID のスレッド。見つからない場合は null。

承認

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

  • https://mail.google.com/

関連情報

getTrashThreads()

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

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

Logger.log(`# of total trash threads: ${GmailApp.getTrashThreads().length}`);

戻る

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

承認

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

  • https://mail.google.com/

getTrashThreads(start, max)

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

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

パラメータ

名前タイプ説明
startInteger取得する最初のスレッドのインデックス
maxInteger取得するスレッドの最大数

戻る

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

承認

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

  • https://mail.google.com/

getUserLabelByName(name)

ラベル名で指定されたラベルを取得します。

const labelObject = GmailApp.getUserLabelByName('myLabel');

パラメータ

名前タイプ説明
nameString取得するラベルの名前

戻る

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

承認

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

  • https://mail.google.com/

getUserLabels()

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

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

戻る

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

承認

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

  • https://mail.google.com/

markMessageRead(message)

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

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

パラメータ

名前タイプ説明
messageGmailMessage既読にするメッセージ

戻る

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

承認

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

  • https://mail.google.com/

関連情報

markMessageUnread(message)

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

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

パラメータ

名前タイプ説明
messageGmailMessage未読にするメッセージ

戻る

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

承認

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

  • https://mail.google.com/

関連情報

markMessagesRead(messages)

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

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

パラメータ

名前タイプ説明
messagesGmailMessage[]既読にするメッセージの配列

戻る

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
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(messages);

パラメータ

名前タイプ説明
messagesGmailMessage[]未読にするメッセージの配列

戻る

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

承認

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

  • https://mail.google.com/

関連情報

markThreadImportant(thread)

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

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

パラメータ

名前タイプ説明
threadGmailThread重要マークを付けるスレッド

戻る

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

承認

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

  • https://mail.google.com/

関連情報

markThreadRead(thread)

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

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

パラメータ

名前タイプ説明
threadGmailThread既読にするスレッド

戻る

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

承認

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

  • https://mail.google.com/

関連情報

markThreadUnimportant(thread)

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

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

パラメータ

名前タイプ説明
threadGmailThread重要でないとマークするスレッド

戻る

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

承認

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

  • https://mail.google.com/

関連情報

markThreadUnread(thread)

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

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

パラメータ

名前タイプ説明
threadGmailThread未読にするスレッド

戻る

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

承認

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

  • https://mail.google.com/

関連情報

markThreadsImportant(threads)

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

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

パラメータ

名前タイプ説明
threadsGmailThread[]重要としてマークするスレッドの配列

戻る

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

承認

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

  • https://mail.google.com/

関連情報

markThreadsRead(threads)

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

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

パラメータ

名前タイプ説明
threadsGmailThread[]既読にするスレッドの配列

戻る

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

承認

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

  • https://mail.google.com/

関連情報

markThreadsUnimportant(threads)

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

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

パラメータ

名前タイプ説明
threadsGmailThread[]重要マークを外すスレッドの配列

戻る

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

承認

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

  • https://mail.google.com/

関連情報

markThreadsUnread(threads)

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

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

パラメータ

名前タイプ説明
threadsGmailThread[]未読にするスレッドの配列

戻る

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

承認

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

  • https://mail.google.com/

関連情報

moveMessageToTrash(message)

メールをゴミ箱に移動し、メールの更新を強制します。

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

パラメータ

名前タイプ説明
messageGmailMessage削除するメッセージ

戻る

GmailApp - Gmail サービス（連鎖に便利）

承認

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

  • https://mail.google.com/

関連情報

moveMessagesToTrash(messages)

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

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

パラメータ

名前タイプ説明
messagesGmailMessage[]削除するメッセージ

戻る

GmailApp - Gmail サービス（連鎖に便利）

承認

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

  • https://mail.google.com/

関連情報

moveThreadToArchive(thread)

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

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

パラメータ

名前タイプ説明
threadGmailThreadアーカイブするスレッド

戻る

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

承認

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

  • https://mail.google.com/

関連情報

moveThreadToInbox(thread)

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

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

パラメータ

名前タイプ説明
threadGmailThread受信トレイに移動するスレッド

戻る

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

承認

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

  • https://mail.google.com/

関連情報

moveThreadToSpam(thread)

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

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

パラメータ

名前タイプ説明
threadGmailThreadスパムに移動するスレッド

戻る

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

承認

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

  • https://mail.google.com/

関連情報

moveThreadToTrash(thread)

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

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

パラメータ

名前タイプ説明
threadGmailThread削除するスレッド

戻る

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

承認

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

  • https://mail.google.com/

関連情報

moveThreadsToArchive(threads)

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

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

パラメータ

名前タイプ説明
threadsGmailThread[]アーカイブするスレッドの配列

戻る

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

承認

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

  • https://mail.google.com/

関連情報

moveThreadsToInbox(threads)

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

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

パラメータ

名前タイプ説明
threadsGmailThread[]受信トレイに移動するスレッドの配列

戻る

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

承認

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

  • https://mail.google.com/

関連情報

moveThreadsToSpam(threads)

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

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

パラメータ

名前タイプ説明
threadsGmailThread[]スパムに移動するスレッドの配列

戻る

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

承認

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

  • https://mail.google.com/

関連情報

moveThreadsToTrash(threads)

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

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

パラメータ

名前タイプ説明
threadsGmailThread[]削除するスレッドの配列

戻る

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

承認

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

  • https://mail.google.com/

関連情報

refreshMessage(message)

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

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

パラメータ

名前タイプ説明
messageGmailMessage更新するメッセージ

戻る

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

承認

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

  • https://mail.google.com/

関連情報

refreshMessages(messages)

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

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

パラメータ

名前タイプ説明
messagesGmailMessage[]更新するメッセージ

戻る

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

承認

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

  • https://mail.google.com/

関連情報

refreshThread(thread)

Gmail からスレッドと関連付けられた状態を再読み込みします（ラベルや既読状態などが変更された場合に便利です）。

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

パラメータ

名前タイプ説明
threadGmailThread更新するスレッド

戻る

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

承認

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

  • https://mail.google.com/

関連情報

refreshThreads(threads)

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

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

パラメータ

名前タイプ説明
threadsGmailThread[]更新するスレッド

戻る

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

承認

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

  • https://mail.google.com/

関連情報

search(query)

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

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

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

パラメータ

名前タイプ説明
queryStringGmail に入力する検索クエリ

戻る

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

承認

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

  • https://mail.google.com/

search(query, start, max)

指定されたクエリで 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.
const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

パラメータ

名前タイプ説明
queryStringGmail に入力する検索クエリ
startInteger開始スレッドのインデックス
maxInteger返すスレッドの最大数

戻る

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

承認

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

  • https://mail.google.com/

sendEmail(recipient, subject, body)

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

// The code below will send an email with the current date and time.
const now = new Date();
GmailApp.sendEmail(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

パラメータ

名前タイプ説明
recipientStringメールアドレスのカンマ区切りのリスト
subjectStringメールの件名（最大 250 文字）
bodyStringメールの本文

戻る

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.
const 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',
    },
);

パラメータ

名前タイプ説明
recipientString受信者のアドレス
subjectString件名（最大 250 文字）
bodyStringメールの本文
optionsObject高度なパラメータを指定する JavaScript オブジェクト（以下を参照）

高度なパラメータ

名前タイプ説明
attachmentsBlobSource[]メールで送信するファイルの配列
bccStringBCC に追加するメールアドレスのカンマ区切りのリスト
ccStringCC に追加するメールアドレスのカンマ区切りのリスト
fromStringメールの送信元アドレス。getAliases() によって返される値のいずれかである必要があります。
htmlBodyString設定されている場合、HTML をレンダリングできるデバイスは、必須の本文引数の代わりにこれを使用します。メールにインライン画像がある場合は、HTML 本文にオプションの inlineImages フィールドを追加できます。
inlineImagesObject画像キー（String）から画像データ（BlobSource）へのマッピングを含む JavaScript オブジェクト。これは、htmlBody パラメータが使用され、これらの画像への参照が <img src="cid:imageKey" /> 形式で含まれていることを前提としています。
nameStringメールの送信者の名前（デフォルト: ユーザーの名前）
noReplyBoolean受信者がメールに返信しないように、一般的な返信不可のメールアドレスからメールを送信する場合は true。このオプションは Google Workspace アカウントでのみ使用でき、Gmail ユーザーは使用できません。
replyToStringデフォルトの返信先アドレスとして使用するメールアドレス （デフォルト: ユーザーのメールアドレス）

戻る

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

承認

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

  • https://mail.google.com/

関連情報

setCurrentMessageAccessToken(accessToken)

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

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

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

パラメータ

名前タイプ説明
accessTokenStringGmail のアドオンのアクション イベント オブジェクトから取得した一時アクセス トークン。

承認

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

  • https://mail.google.com/

starMessage(message)

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

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

パラメータ

名前タイプ説明
messageGmailMessageスターを付けるメッセージ

戻る

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

承認

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

  • https://mail.google.com/

関連情報

starMessages(messages)

これらのメッセージにスターを追加し、メッセージを強制的に更新します。

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

パラメータ

名前タイプ説明
messagesGmailMessage[]スターを付けるメッセージの配列

戻る

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

承認

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

  • https://mail.google.com/

関連情報

unstarMessage(message)

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

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

パラメータ

名前タイプ説明
messageGmailMessageスターを外すメッセージ

戻る

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

承認

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

  • https://mail.google.com/

関連情報

unstarMessages(messages)

これらのメッセージからスターを削除し、メッセージを強制的に更新します。

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

パラメータ

名前タイプ説明
messagesGmailMessage[]スターを外すメッセージの配列

戻る

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

承認

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

  • https://mail.google.com/

関連情報

サポート終了のメソッド