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
- 新しく作成した Gmail 下書き
認証
このメソッドを使用するスクリプトには、次のうち 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 をレンダリングします。メールのインライン画像がある場合は、HTML 本文にオプションの inlineImages フィールドを追加できます。 |
inlineImages | Object | 画像キー(String )から画像データ(BlobSource )へのマッピングを含む JavaScript オブジェクト。これは、htmlBody パラメータが使用され、これらの画像への参照が <img src="cid:imageKey" /> 形式で含まれていることを前提としています。 |
name | String | メールの送信者の名前(デフォルト: ユーザーの名前) |
replyTo | String | デフォルトの返信先アドレスとして使用するメールアドレス(デフォルト: ユーザーのメールアドレス) |
戻る
GmailDraft
- 新しく作成した Gmail 下書き
認証
このメソッドを使用するスクリプトには、次のうち 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()
ラベルに関係なく、すべての受信トレイのスレッドを取得します。
この呼び出しは、すべてのスレッドのサイズが大きすぎてシステムが処理できない場合に失敗します。スレッドサイズが不明で、おそらく非常に大きい場合は、' 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[]
- Inbox の 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[]
- Inbox の 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()
ラベルに関係なく、すべての優先トレイ スレッドを取得します。
この呼び出しは、すべてのスレッドのサイズが大きすぎてシステムが処理できない場合に失敗します。スレッドサイズが不明で、おそらく非常に大きい場合は、' paged' 呼び出しを使用し、各呼び出しで取得するスレッドの範囲を指定します。
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()
ラベルに関係なく、すべてのスパムスレッドを取得します。
この呼び出しは、すべてのスレッドのサイズが大きすぎてシステムが処理できない場合に失敗します。スレッドサイズが不明で、おそらく非常に大きい場合は、' paged' 呼び出しを使用し、各呼び出しで取得するスレッドの範囲を指定します。
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()
ラベルに関係なく、すべてのスター付きスレッドを取得します。
この呼び出しは、すべてのスレッドのサイズが大きすぎてシステムが処理できない場合に失敗します。スレッドサイズが不明で、おそらく非常に大きい場合は、' paged' 呼び出しを使用し、各呼び出しで取得するスレッドの範囲を指定します。
// 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() と組み合わせて使用します。
// Thread IDs can also be found in the location bar when you have a thread open in Gmail // get first inbox thread var firstThread = GmailApp.getInboxThreads(0,1)[0]; // Get the same thread by ID var threadById = GmailApp.getThreadById(firstThread.getId()); // Verify they are the same Logger.log(firstThread.getFirstMessageSubject() == threadById.getFirstMessageSubject());
パラメータ
名前 | 型 | 説明 |
---|---|---|
id | String | 取得するスレッドの ID |
戻る
GmailThread
- 指定された ID のスレッド。見つからない場合は null になります。
認証
このメソッドを使用するスクリプトには、次のうち 1 つ以上のスコープまたは関連する REST API による適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
getTrashThreads()
ラベルに関係なく、すべてのゴミ箱スレッドを取得します。
この呼び出しは、すべてのスレッドのサイズが大きすぎてシステムが処理できない場合に失敗します。スレッドサイズが不明で、おそらく非常に大きい場合は、' paged' 呼び出しを使用し、各呼び出しで取得するスレッドの範囲を指定します。
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 を検索します。
この呼び出しは、すべてのスレッドのサイズが大きすぎてシステムが処理できない場合に失敗します。スレッドサイズが不明で、おそらく非常に大きい場合は、' paged' 呼び出しを使用し、各呼び出しで取得するスレッドの範囲を指定します。
// 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 文字) |
body | String | メールの本文 |
options | Object | 高度なパラメータを指定する JavaScript オブジェクト(下記を参照) |
拡張パラメータ
名前 | 型 | 説明 |
---|---|---|
attachments | BlobSource[] | メールで送信するファイルの配列 |
bcc | String | BCC 宛てのメールアドレスのカンマ区切りリスト |
cc | String | Cc に含めるメールアドレスのカンマ区切りリスト |
from | String | メールの送信元のアドレス(getAliases() によって返された値のいずれか) |
htmlBody | String | 設定すると、HTML をレンダリングできるデバイスでは、必須の本文引数の代わりに、HTML をレンダリングします。メールのインライン画像がある場合は、HTML 本文にオプションの inlineImages フィールドを追加できます。 |
inlineImages | Object | 画像キー(String )から画像データ(BlobSource )へのマッピングを含む JavaScript オブジェクト。これは、htmlBody パラメータが使用され、これらの画像への参照が <img src="cid:imageKey" /> 形式で含まれていることを前提としています。 |
name | String | メールの送信者の名前(デフォルト: ユーザーの名前) |
noReply | Boolean | true : 受信者がメールに返信しないように、返信しない汎用的なメールアドレスからメールを送信する場合に必要です。このオプションは、Gmail ユーザーではなく、Google Workspace アカウントでのみ使用可能です。 |
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/