Gmail のスレッド、メール、ラベルへのアクセスを許可します。
Methods
詳細なドキュメント
createDraft(recipient, subject, body)
メールの下書きを作成します。メールのサイズ(ヘッダーを含む)には割り当てが制限されています。
// 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());
パラメータ
名前 | 型 | 説明 |
---|---|---|
recipient | String | メールアドレスのカンマ区切りのリスト |
subject | String | メールの件名 |
body | String | メールの本文 |
リターン
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' });
パラメータ
名前 | 型 | 説明 |
---|---|---|
recipient | String | 受信者のアドレス |
subject | String | 件名 |
body | String | メールの本文 |
options | Object | 詳細パラメータを指定する JavaScript オブジェクト(下記を参照) |
拡張パラメータ
名前 | 型 | 説明 |
---|---|---|
attachments | BlobSource[] | メールと一緒に送信するファイルの配列 |
bcc | String | Bcc で送信するメールアドレスのカンマ区切りのリスト |
cc | String | Cc に含めるメールアドレスのカンマ区切りのリスト |
from | String | メールの送信元アドレス。getAliases() によって返される値のいずれかにする必要があります。 |
htmlBody | String | 設定すると、HTML をレンダリングできるデバイスは、必須の本文引数の代わりにそれを使用します。メール用にインライン画像を用意する場合は、HTML 本文にオプションの inlineImages フィールドを追加できます。 |
inlineImages | Object | 画像キー(String )から画像データ(BlobSource )へのマッピングを含む JavaScript オブジェクト。これは、htmlBody パラメータが使用され、<img src="cid:imageKey" /> 形式でこれらの画像への参照が含まれていることを前提としています。 |
name | String | メールの送信者の名前(デフォルト: ユーザー名) |
replyTo | String | デフォルトの返信先アドレスとして使用するメールアドレス(デフォルト: ユーザーのメールアドレス) |
リターン
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"));
パラメータ
名前 | 型 | 説明 |
---|---|---|
name | String | 新しいラベルの名前 |
リターン
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
label | GmailLabel | 削除するラベルです。 |
リターン
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. 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/
関連ドキュメント
getDraft(draftId)
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());
パラメータ
名前 | 型 | 説明 |
---|---|---|
draftId | String | 取得する下書きの ID |
リターン
GmailDraft
- 指定された ID のドラフト
例外
Error
- 指定された ID の下書きが見つからない場合
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
getDraftMessages()
すべての下書きメッセージを取得します。
// Logs the number of draft messages var drafts = GmailApp.getDraftMessages(); Logger.log(drafts.length);
リターン
GmailMessage[]
- Gmail の下書きメッセージの配列
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
getDrafts()
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/
getInboxThreads()
ラベルに関係なく、受信トレイのすべてのスレッドを取得します。
すべてのスレッドのサイズが大きすぎてシステムで処理できない場合、この呼び出しは失敗します。スレッドサイズが不明で、非常に大きくなる可能性がある場合は、「ページング」呼び出しを使用して、各呼び出しで取得するスレッドの範囲を指定してください。
// 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/
getInboxThreads(start, max)
ラベルに関係なく、受信トレイのスレッドの範囲を取得します。
// 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()); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | 取得する最初のスレッドのインデックス |
max | Integer | 取得するスレッドの最大数 |
リターン
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 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());
パラメータ
名前 | 型 | 説明 |
---|---|---|
id | String | 取得するメッセージの 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 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()); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
thread | GmailThread | メッセージのスレッドを |
リターン
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()); } }
パラメータ
名前 | 型 | 説明 |
---|---|---|
threads | GmailThread[] | 取得するメッセージのスレッドを |
リターン
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | 取得する最初のスレッドのインデックス |
max | Integer | 取得するスレッドの最大数 |
リターン
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | 取得する最初のスレッドのインデックス |
max | Integer | 取得するスレッドの最大数 |
リターン
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | 取得する最初のスレッドのインデックス |
max | Integer | 取得するスレッドの最大数 |
リターン
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());
パラメータ
名前 | 型 | 説明 |
---|---|---|
id | String | 取得するスレッドの ID。 |
リターン
GmailThread
- 指定された 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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | 取得する最初のスレッドのインデックス |
max | Integer | 取得するスレッドの最大数 |
リターン
GmailThread[]
- ゴミ箱内の Gmail スレッドの配列
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
getUserLabelByName(name)
指定したラベル名のラベルを取得します。
var labelObject = GmailApp.getUserLabelByName("myLabel");
パラメータ
名前 | 型 | 説明 |
---|---|---|
name | String | 取得するラベルの名前 |
リターン
GmailLabel
- 指定した名前の Gmail ラベル
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
getUserLabels()
ユーザーが作成したラベルのリストを取得します。
// 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/
markMessageRead(message)
このメッセージを既読にし、メッセージを強制的に更新します。
// 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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
message | GmailMessage | 既読にするメッセージ |
リターン
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
message | GmailMessage | メッセージを未読にする |
リターン
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. var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); var messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesRead(thread.getMessages());
パラメータ
名前 | 型 | 説明 |
---|---|---|
messages | GmailMessage[] | 既読としてマークするメッセージの配列 |
リターン
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());
パラメータ
名前 | 型 | 説明 |
---|---|---|
messages | GmailMessage[] | 未読としてマークするメッセージの配列 |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
markThreadImportant(thread)
このスレッドに重要マークを付けて、スレッドを強制的に更新します。
// Marks first inbox thread as important var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadImportant(thread);
パラメータ
名前 | 型 | 説明 |
---|---|---|
thread | GmailThread | 重要マークを付ける |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
markThreadRead(thread)
このスレッドを既読としてマークし、スレッドを強制的に更新します。
// Marks first inbox thread as read var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadRead(thread);
パラメータ
名前 | 型 | 説明 |
---|---|---|
thread | GmailThread | 既読にするスレッドの |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
markThreadUnimportant(thread)
このスレッドを重要でないものとしてマークし、スレッドを強制的に更新します。
// Marks first inbox thread as unimportant var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnimportant(thread);
パラメータ
名前 | 型 | 説明 |
---|---|---|
thread | GmailThread | 重要マークを外すスレッドの |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
markThreadUnread(thread)
このスレッドを未読にして、スレッドを強制的に更新します。
// Marks first inbox thread as unread var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnread(thread);
パラメータ
名前 | 型 | 説明 |
---|---|---|
thread | GmailThread | 未読にするスレッドの |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
markThreadsImportant(threads)
これらのスレッドに重要マークを付けて、スレッドを強制的に更新します。
// Marks first two threads in inbox as important var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsImportant(threads);
パラメータ
名前 | 型 | 説明 |
---|---|---|
threads | GmailThread[] | 重要としてマークするスレッドの配列 |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
markThreadsRead(threads)
これらのスレッドを既読としてマークし、スレッドを強制的に更新します。
// Marks first two threads in inbox as read var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsRead(threads);
パラメータ
名前 | 型 | 説明 |
---|---|---|
threads | GmailThread[] | 既読としてマークするスレッドの配列 |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
markThreadsUnimportant(threads)
これらのスレッドを重要でないものとしてマークし、スレッドを強制的に更新します。
// Marks first two threads in inbox as unimportant var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnimportant(threads);
パラメータ
名前 | 型 | 説明 |
---|---|---|
threads | GmailThread[] | 重要でないとマークするスレッドの配列 |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
markThreadsUnread(threads)
これらのスレッドを未読としてマークし、スレッドを強制的に更新します。
// Marks first two threads in inbox as unread var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnread(threads);
パラメータ
名前 | 型 | 説明 |
---|---|---|
threads | GmailThread[] | 未読としてマークするスレッドの配列 |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
moveMessageToTrash(message)
メッセージをゴミ箱に移動し、強制的に更新します。
// Move the first message in your inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; var firstMessage = firstThread.getMessages()[0]; GmailApp.moveMessageToTrash(firstMessage);
パラメータ
名前 | 型 | 説明 |
---|---|---|
message | GmailMessage | メッセージをゴミ箱に移動します |
リターン
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
messages | GmailMessage[] | メッセージをゴミ箱に入れます |
リターン
GmailApp
- Gmail サービス(チェーンに便利です)
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
moveThreadToArchive(thread)
このスレッドをアーカイブに移動し、強制的に更新します。
// Archive the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToArchive(firstThread);
パラメータ
名前 | 型 | 説明 |
---|---|---|
thread | GmailThread | アーカイブするスレッドの |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
moveThreadToInbox(thread)
このスレッドを受信トレイに移動し、強制的に更新します。
// Find a thread not already in your inbox var thread = GmailApp.search("-in:inbox")[0]; // Get the first one GmailApp.moveThreadToInbox(thread);
パラメータ
名前 | 型 | 説明 |
---|---|---|
thread | GmailThread | 受信トレイに移動するスレッドの |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
moveThreadToSpam(thread)
このスレッドを [スパム] に移動し、スレッドを強制的に更新します。
// Tag first thread in inbox as spam var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToSpam(firstThread);
パラメータ
名前 | 型 | 説明 |
---|---|---|
thread | GmailThread | 移動されるスレッドが |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
moveThreadToTrash(thread)
このスレッドをゴミ箱に移動して、スレッドを強制的に更新します。
// Move first thread in inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToTrash(firstThread);
パラメータ
名前 | 型 | 説明 |
---|---|---|
thread | GmailThread | スレッドを削除します。 |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
moveThreadsToArchive(threads)
これらのスレッドをアーカイブに移動し、強制的に更新します。
// Move first two threads in your inbox to the archive var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToArchive(firstTwoThreads);
パラメータ
名前 | 型 | 説明 |
---|---|---|
threads | GmailThread[] | アーカイブするスレッドの配列 |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
moveThreadsToInbox(threads)
これらのスレッドを受信トレイに移動し、強制的に更新します。
// Find two threads not already in your inbox var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2); GmailApp.moveThreadsToInbox(firstTwoThreads);
パラメータ
名前 | 型 | 説明 |
---|---|---|
threads | GmailThread[] | 受信トレイに移動するスレッドの配列 |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
moveThreadsToSpam(threads)
これらのスレッドをスパムに移動し、強制的に更新します。
// Move first two threads in your inbox to spam var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToSpam(firstTwoThreads);
パラメータ
名前 | 型 | 説明 |
---|---|---|
threads | GmailThread[] | スパムに移動するスレッドの配列 |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
moveThreadsToTrash(threads)
これらのスレッドをゴミ箱に移動し、強制的に更新します。
// Move first two threads in your inbox to trash var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToTrash(firstTwoThreads);
パラメータ
名前 | 型 | 説明 |
---|---|---|
threads | GmailThread[] | ゴミ箱に移動するスレッドの配列 |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
refreshMessage(message)
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...
パラメータ
名前 | 型 | 説明 |
---|---|---|
message | GmailMessage | 更新するメッセージです |
リターン
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...
パラメータ
名前 | 型 | 説明 |
---|---|---|
messages | GmailMessage[] | 更新するメッセージです。 |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
refreshThread(thread)
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 ...
パラメータ
名前 | 型 | 説明 |
---|---|---|
thread | GmailThread | 更新するスレッドを |
リターン
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 ...
パラメータ
名前 | 型 | 説明 |
---|---|---|
threads | GmailThread[] | 更新するスレッドを |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
search(query)
指定されたクエリで Gmail を検索します。
すべてのスレッドのサイズが大きすぎてシステムで処理できない場合、この呼び出しは失敗します。スレッドサイズが不明で、非常に大きくなる可能性がある場合は、「ページング」呼び出しを使用して、各呼び出しで取得するスレッドの範囲を指定してください。
// Find starred messages with subject IMPORTANT var threads = GmailApp.search('is:starred subject:"IMPORTANT"');
パラメータ
名前 | 型 | 説明 |
---|---|---|
query | String | Gmail に入力するような検索クエリを |
リターン
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. var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);
パラメータ
名前 | 型 | 説明 |
---|---|---|
query | String | Gmail に入力するような検索クエリを |
start | Integer | 開始スレッドのインデックス |
max | Integer | 返されるスレッドの最大数 |
リターン
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. var now = new Date(); GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());
パラメータ
名前 | 型 | 説明 |
---|---|---|
recipient | String | メールアドレスのカンマ区切りのリスト |
subject | String | メールの件名(最大 250 文字) |
body | String | メールの本文 |
リターン
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' });
パラメータ
名前 | 型 | 説明 |
---|---|---|
recipient | String | 受信者のアドレス |
subject | String | 件名(最大半角 250 文字(全角 125 文字)) |
body | String | メールの本文 |
options | Object | 詳細パラメータを指定する JavaScript オブジェクト(下記を参照) |
拡張パラメータ
名前 | 型 | 説明 |
---|---|---|
attachments | BlobSource[] | メールと一緒に送信するファイルの配列 |
bcc | String | Bcc で送信するメールアドレスのカンマ区切りのリスト |
cc | String | Cc に含めるメールアドレスのカンマ区切りのリスト |
from | String | メールの送信元アドレス。getAliases() によって返される値のいずれかにする必要があります。 |
htmlBody | String | 設定すると、HTML をレンダリングできるデバイスは、必須の本文引数の代わりにそれを使用します。メール用にインライン画像を用意する場合は、HTML 本文にオプションの inlineImages フィールドを追加できます。 |
inlineImages | Object | 画像キー(String )から画像データ(BlobSource )へのマッピングを含む JavaScript オブジェクト。これは、htmlBody パラメータが使用され、<img src="cid:imageKey" /> 形式でこれらの画像への参照が含まれていることを前提としています。 |
name | String | メールの送信者の名前(デフォルト: ユーザー名) |
noReply | Boolean | true : 受信者がメールに返信しないよう、一般的な返信不可のメールアドレスからメールを送信する必要がある場合。このオプションは Google Workspace アカウントでのみ使用できます。Gmail ユーザーでは使用できません。 |
replyTo | String | デフォルトの返信先アドレスとして使用するメールアドレス(デフォルト: ユーザーのメールアドレス) |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
setCurrentMessageAccessToken(accessToken)
現在のメッセージ アクセス トークンを設定して、スクリプトが現在の 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 }
パラメータ
名前 | 型 | 説明 |
---|---|---|
accessToken | String | Gmail アドオンのアクション イベント オブジェクトから取得した一時アクセス トークン。 |
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
starMessage(message)
このメッセージにスターを付けて、メッセージを強制的に更新します。
// 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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
message | GmailMessage | スターを付けるメッセージ |
リターン
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
messages | GmailMessage[] | スターを付けるメッセージの配列 |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
unstarMessage(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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
message | GmailMessage | メッセージからスターを外す |
リターン
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);
パラメータ
名前 | 型 | 説明 |
---|---|---|
messages | GmailMessage[] | スターを外すメッセージの配列 |
リターン
GmailApp
- Gmail サービス。チェーン接続に便利です。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/