Class GmailMessage

Gmail メッセージ

ユーザーの Gmail アカウントに投稿されたメッセージ。

Methods

メソッド	戻り値の型	概要
createDraftReply(body)	GmailDraft	このメッセージの送信者に返信するアドレスを使用して、返信メッセージを作成する下書きを作成します。
createDraftReply(body, options)	GmailDraft	返信先アドレスを使用して、オプションの引数を指定して、このメッセージの送信者に返信する下書きメッセージを作成します。
createDraftReplyAll(body)	GmailDraft	返信先アドレスとこのメッセージのすべての受信者を使用して、送信者に返信する下書きメッセージを作成します。
createDraftReplyAll(body, options)	GmailDraft	返信先アドレスとすべての受信者を使用して、このメッセージの送信元に返信するメッセージの下書きを作成します。オプション引数を指定できます。
forward(recipient)	GmailMessage	このメッセージを新しい受信者に転送します。
forward(recipient, options)	GmailMessage	オプションの引数を使用して、このメッセージを新しい受信者に転送します。
getAttachments()	GmailAttachment[]	このメッセージのすべての添付ファイルを取得します。
getAttachments(options)	GmailAttachment[]	このメッセージのすべての添付ファイルを取得します。
getBcc()	String	このメッセージの Bcc に指定されているカンマ区切りの受信者を取得します。
getBody()	String	このメッセージの本文の HTML コンテンツを取得します。
getCc()	String	このメッセージの Cc 配信先のカンマ区切りのリストを取得します。
getDate()	Date	このメッセージの日時を取得します。
getFrom()	String	このメッセージの送信者を取得します。
getHeader(name)	String	ヘッダー名が指定された RFC 2822 ヘッダーの値を取得します。
getId()	String	このメッセージの ID を取得します。
getPlainBody()	String	HTML 形式を指定せずにこのメッセージの本文のコンテンツを取得します。
getRawContent()	String	このメッセージの未加工のコンテンツを取得します。
getReplyTo()	String	このメッセージの返信先アドレス（通常は送信者）を取得します。
getSubject()	String	このメッセージの件名を取得します。
getThread()	GmailThread	このメッセージを含むスレッドを取得します。
getTo()	String	このメッセージのカンマ区切りの受信者を取得します。
isDraft()	Boolean	このメッセージが下書きかどうかを取得します。
isInChats()	Boolean	このメッセージがチャットかどうかを取得します。
isInInbox()	Boolean	このメッセージが受信トレイにあるかどうかを取得します。
isInPriorityInbox()	Boolean	このメッセージが優先トレイにある場合は true を返し、それ以外の場合は false を返します。
isInTrash()	Boolean	このメッセージがゴミ箱にあるかどうかを取得します。
isStarred()	Boolean	このメッセージがスター付きであるかどうかを取得します。
isUnread()	Boolean	このメッセージが未読であるかどうかを取得します。
markRead()	GmailMessage	メッセージを既読にします。
markUnread()	GmailMessage	メッセージを未読にします。
moveToTrash()	GmailMessage	メールをゴミ箱に移動します。
refresh()	GmailMessage	このメッセージとそれに関連する状態を Gmail から再読み込みします（ラベル、読み取り状態などが変更された場合に役立ちます）。
reply(body)	GmailMessage	返信先アドレスを使用して、このメッセージの送信者に返信します。
reply(body, options)	GmailMessage	オプションの引数を指定して、返信先アドレスを使用して、このメッセージの送信者に返信します。
replyAll(body)	GmailMessage	返信先アドレスとこのメッセージのすべての受信者を使用して送信者に返信します。
replyAll(body, options)	GmailMessage	このメッセージの送信元に対し、返信先アドレスとすべての受信者を、オプションの引数とともに返します。
star()	GmailMessage	メッセージにスターを付けます。
unstar()	GmailMessage	メッセージのスターを外します。

詳細なドキュメント

createDraftReply(body)

このメッセージの送信者に返信するアドレスを使用して、返信メッセージを作成する下書きを作成します。メール（ヘッダーを含む）のサイズは割り当て上限があります。

// Create a draft reply to the original message with an acknowledgment.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("Got your message");

パラメータ

名前	型	説明
body	String	メールの本文。

復路

GmailDraft - 新しく作成された下書きメッセージ。

承認

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

• https://mail.google.com/

関連ドキュメント

• reply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)
• createDraftReplyAll(body, options)

---

createDraftReply(body, options)

返信先アドレスを使用して、省略可能な引数を指定して、このメッセージの送信者に返信する下書きメッセージを作成します。

このメールには、書式なしテキストと HTML 本文の両方を含めることができます。メール（ヘッダーを含む）のサイズは割り当て上限があります。

// Create a draft response with an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "[e-mail]"
});

パラメータ

名前	型	説明
body	String	メールの本文。
options	Object	下記の詳細なパラメータを指定する JavaScript オブジェクト。

拡張パラメータ

名前	型	説明
attachments	BlobSource[]	メールとともに送信するファイルの配列
bcc	String	BCC へのメールアドレスのカンマ区切りリスト
cc	String	CC に送信するメールアドレスのカンマ区切りリスト
from	String	メールの送信元アドレス。GmailApp.getAliases() によって返される値のいずれかである必要があります。
htmlBody	String	設定されている場合、HTML をレンダリングできるデバイスでは、必要な本文の引数ではなく、このフィールドを使用します。メールにインライン画像がある場合は、HTML の本文にオプションの inlineImages フィールドを追加できます
inlineImages	Object	画像キー（String）から画像データ（BlobSource）へのマッピングを含む JavaScript オブジェクト。htmlBody パラメータを使用し、<img src="cid:imageKey" /> 形式の画像への参照を含むことを前提としています。
name	String	メールの送信者の名前（デフォルト: ユーザーの名前）
replyTo	String	デフォルトの返信先アドレスとして使用するメールアドレス（デフォルト: ユーザーのメールアドレス）
subject	String	メールの件名（半角 250 文字、全角 120 文字まで）。

復路

GmailDraft - 新しく作成された下書きメッセージ。

承認

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

• https://mail.google.com/

関連ドキュメント

• reply(body, options)
• createDraftReply(body)
• createDraftReplyAll(body)
• createDraftReplyAll(body, options)

---

createDraftReplyAll(body)

返信先アドレスとこのメッセージのすべての受信者を使用して、送信者に返信する下書きメッセージを作成します。メール（ヘッダーを含む）のサイズには上限があります。

// Create a draft response to all recipients (except those bcc'd) with an acknowledgment.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("Got your message");

パラメータ

名前	型	説明
body	String	メールの本文。

復路

GmailDraft - 新しく作成された下書きメッセージ。

承認

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

• https://mail.google.com/

関連ドキュメント

• replyAll(body)
• createDraftReply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body, options)

---

createDraftReplyAll(body, options)

返信先アドレスとすべての受信者を使用して、このメッセージの送信者に返信するメッセージの下書きを作成します。オプション引数を指定できます。

このメールには、書式なしテキストと HTML 本文の両方を含めることができます。メール（ヘッダーを含む）のサイズは割り当て上限があります。

// Create a draft response to all recipients (except those bcc'd) using an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "[e-mail]"
});

パラメータ

名前	型	説明
body	String	メールの本文。
options	Object	下記の詳細なパラメータを指定する JavaScript オブジェクト。

拡張パラメータ

名前	型	説明
attachments	BlobSource[]	メールとともに送信するファイルの配列
bcc	String	BCC へのメールアドレスのカンマ区切りリスト
cc	String	CC に送信するメールアドレスのカンマ区切りリスト
from	String	メールの送信元アドレス。GmailApp.getAliases() によって返される値のいずれかである必要があります。
htmlBody	String	設定されている場合、HTML をレンダリングできるデバイスでは、必要な本文の引数ではなく、このフィールドを使用します。メールにインライン画像がある場合は、HTML の本文にオプションの inlineImages フィールドを追加できます
inlineImages	Object	画像キー（String）から画像データ（BlobSource）へのマッピングを含む JavaScript オブジェクト。htmlBody パラメータを使用し、<img src="cid:imageKey" /> 形式の画像への参照を含むことを前提としています。
name	String	メールの送信者の名前（デフォルト: ユーザーの名前）
replyTo	String	デフォルトの返信先アドレスとして使用するメールアドレス（デフォルト: ユーザーのメールアドレス）
subject	String	メールの件名（半角 250 文字、全角 120 文字まで）。

復路

GmailDraft - 新しく作成された下書きメッセージ。

承認

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

• https://mail.google.com/

関連ドキュメント

• replyAll(body, options)
• createDraftReply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)

---

forward(recipient)

このメッセージを新しい受信者に転送します。メール（ヘッダーを含む）のサイズには上限があります。

// Forward first message of first inbox thread to recipient1 & recipient2, both @example.com
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("[e-mail],[e-mail]");

パラメータ

名前	型	説明
recipient	String	メールアドレスのカンマ区切りリスト。

復路

GmailMessage - このメッセージは、チェーンに役立ちます。

承認

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

• https://mail.google.com/

関連ドキュメント

• forward(recipient, options)

---

forward(recipient, options)

オプションの引数を使用して、このメッセージを新しい受信者に転送します。

このメールには、書式なしテキストと HTML 本文の両方を含めることができます。メール（ヘッダーを含む）のサイズは割り当て上限があります。

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("[e-mail],[e-mail]", {
  cc: "[e-mail]",
  bcc: "[e-mail],[e-mail]"
});

パラメータ

名前	型	説明
recipient	String	メールアドレスのカンマ区切りリスト。
options	Object	下記の詳細なパラメータを指定する JavaScript オブジェクト。

拡張パラメータ

名前	型	説明
attachments	BlobSource[]	メールとともに送信するファイルの配列
bcc	String	BCC へのメールアドレスのカンマ区切りリスト
cc	String	CC に送信するメールアドレスのカンマ区切りリスト
from	String	メールの送信元アドレス。GmailApp.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	デフォルトの返信先アドレスとして使用するメールアドレス（デフォルト: ユーザーのメールアドレス）
subject	String	メールの件名（半角 250 文字、全角 120 文字まで）。

復路

GmailMessage - このメッセージは、チェーンに役立ちます。

承認

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

• https://mail.google.com/

関連ドキュメント

• forward(recipient)

---

getAttachments()

このメッセージのすべての添付ファイルを取得します。

復路

GmailAttachment[] - このメッセージの Blob アタッチメントの配列。

承認

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

• https://mail.google.com/

---

getAttachments(options)

このメッセージのすべての添付ファイルを取得します。

パラメータ

名前	型	説明
options	Object	下記の詳細なパラメータを指定する JavaScript オブジェクト。

拡張パラメータ

名前	型	説明
includeInlineImages	Boolean	true は、返される Blob アタッチメントの配列にインライン画像を含める場合（デフォルトは true）です。
includeAttachments	Boolean	true 返される Blob アタッチメントの配列に、通常の（インラインではない）添付ファイルが含まれている場合（デフォルトは true）。

復路

GmailAttachment[] - このメッセージの Blob アタッチメントの配列。

承認

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

• https://mail.google.com/

---

getBcc()

このメッセージの Bcc に指定されているカンマ区切りの宛先を取得します。

定義上、これは受信したすべてのメッセージで空になります。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getBcc()); // Log bcc'd addresses

復路

String - このメッセージの Bcc に指定されているカンマ区切りのリスト。

承認

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

• https://mail.google.com/

関連ドキュメント

• getTo()

---

getBody()

このメッセージの本文の HTML コンテンツを取得します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getBody()); // Log contents of the body

復路

String - このメッセージの本文。

承認

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

• https://mail.google.com/

関連ドキュメント

• getSubject()

---

getCc()

このメッセージの Cc 送信先のカンマ区切りのリストを取得します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getCc()); // Log cc'd addresses

復路

String - このメールの Cc 宛先のカンマ区切り。

承認

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

• https://mail.google.com/

関連ドキュメント

• getTo()

---

getDate()

このメッセージの日時を取得します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getDate()); // Log date and time of the message

復路

Date - このメッセージの日時。

承認

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

• https://mail.google.com/

---

getFrom()

このメッセージの送信者を取得します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getFrom()); // Log from address of the message

復路

String - メッセージの送信者のメールアドレス。

承認

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

• https://mail.google.com/

関連ドキュメント

• getReplyTo()

---

getHeader(name)

ヘッダー名が指定された RFC 2822 ヘッダーの値を取得します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox.
var message = thread.getMessages()[0];         // Get the first message.
Logger.log(message.getHeader("Message-ID"));   // Logs the Message-ID RFC 2822 header.

パラメータ

名前	型	説明
name	String	RFC ヘッダーの名前。値とコロンが区切りません。

復路

String - ヘッダーの値。メッセージにヘッダーが存在しない場合は空の文字列です。

承認

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

• https://mail.google.com/

---

getId()

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
var id = message.getId();
var messageById = GmailApp.getMessageById(id);
Logger.log(message.getSubject() == messageById.getMessage()); // Always logs true

復路

String - メッセージ ID。

---

getPlainBody()

HTML 形式を指定せずにこのメッセージの本文のコンテンツを取得します。これは getBody() よりも複雑で、時間がかかります。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getPlainBody()); // Log contents of the body

復路

String - このメッセージの書式なしコンテンツ。

承認

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

• https://mail.google.com/

関連ドキュメント

• getSubject()

---

getRawContent()

このメッセージの未加工のコンテンツを取得します。これは、Gmail の UI の「メッセージのソースを表示」と同等です。

復路

String - このメッセージの生のコンテンツ。

承認

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

• https://mail.google.com/

---

getReplyTo()

このメッセージの返信先アドレス（通常は送信者）を取得します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getReplyTo()); // Logs reply-to address

復路

String - 返信用のメールアドレス。

承認

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

• https://mail.google.com/

関連ドキュメント

• getCc()

---

getSubject()

このメッセージの件名を取得します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getSubject()); // Log subject line

復路

String - このメッセージの件名。

承認

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

• https://mail.google.com/

関連ドキュメント

• getAttachments()

---

getThread()

このメッセージを含むスレッドを取得します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getThread().getFirstMessageSubject() ==
           thread.getFirstMessageSubject()); // Always logs true

復路

GmailThread - このメッセージが含まれている GmailThread。

承認

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

• https://mail.google.com/

---

getTo()

このメッセージのカンマ区切りの受信者を取得します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getTo()); // Log the recipient of message

復路

String - このメッセージのカンマ区切り受信者。

承認

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

• https://mail.google.com/

関連ドキュメント

• getCc()

---

isDraft()

このメッセージが下書きかどうかを取得します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is draft? " + message.isDraft());

復路

Boolean - このメッセージが下書きかどうか。

承認

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

• https://mail.google.com/

---

isInChats()

このメッセージがチャットかどうかを取得します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is a chat? " + message.isInChats());

復路

Boolean - メッセージがチャットであるかどうか。

---

isInInbox()

このメッセージが受信トレイにあるかどうかを取得します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in inbox? " + message.isInInbox());

復路

Boolean - このメッセージが受信トレイにあるかどうか。

承認

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

• https://mail.google.com/

---

isInPriorityInbox()

このメッセージが優先トレイにある場合は true を返し、それ以外の場合は false を返します。

var thread = GmailApp.getPriorityInboxThreads(0,1)[0]; // Get first thread in priority inbox
var messages = thread.getMessages();
for (var i = 0; i < messages.length; i++) {
  // At least one of the messages is in priority inbox
  Logger.log("is in priority inbox? " + messages[i].isInPriorityInbox());
}

復路

Boolean - このメッセージが優先トレイに存在するかどうか。

承認

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

• https://mail.google.com/

---

isInTrash()

このメッセージがゴミ箱にあるかどうかを取得します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in the trash? " + message.isInTrash());

復路

Boolean - このメッセージがゴミ箱にあるかどうか。

---

isStarred()

このメッセージがスター付きであるかどうかを取得します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is starred? " + message.isStarred());

復路

Boolean - このメッセージがスター付きかどうか。

---

isUnread()

このメッセージが未読かどうかを示します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is unread? " + message.isUnread());

復路

Boolean - このメッセージの未読ステータス。

承認

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

• https://mail.google.com/

---

markRead()

メッセージを既読にします。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.markRead(); // Mark as read

復路

GmailMessage - チェーンに役立つ GmailMessage。

承認

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

• https://mail.google.com/

関連ドキュメント

• isUnread()

---

markUnread()

メッセージを未読にします。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.markUnread(); // Mark as unread

復路

GmailMessage - チェーンに役立つ GmailMessage。

承認

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

• https://mail.google.com/

関連ドキュメント

• isUnread()

---

moveToTrash()

メールをゴミ箱に移動します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.moveToTrash(); // Move message to trash

復路

GmailMessage - チェーンに役立つ GmailMessage。

承認

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

• https://mail.google.com/

関連ドキュメント

• isInTrash()

---

refresh()

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
// .. Do bunch of stuff here
message.refresh(); // Make sure it's up to date
// Do more stuff to message

復路

GmailMessage - チェーンに使用するメッセージ。

承認

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

• https://mail.google.com/

---

reply(body)

返信先アドレスを使用して、このメッセージの送信者に返信します。メール（ヘッダーを含む）のサイズは割り当て上限があります。

// Respond to author of message with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.reply("Got your message");

パラメータ

名前	型	説明
body	String	メールの本文。

復路

GmailMessage - このメッセージは、チェーンに役立ちます。

承認

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

• https://mail.google.com/

関連ドキュメント

• reply(body, options)
• replyAll(body)
• replyAll(body, options)

---

reply(body, options)

オプションの引数を指定して、返信先アドレスを使用して、このメッセージの送信者に返信します。

このメールには、書式なしテキストと HTML 本文の両方を含めることができます。メール（ヘッダーを含む）のサイズは割り当て上限があります。

// Respond with HTML body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.reply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  noReply: true
});

パラメータ

名前	型	説明
body	String	メールの本文。
options	Object	下記の詳細なパラメータを指定する JavaScript オブジェクト。

拡張パラメータ

名前	型	説明
attachments	BlobSource[]	メールとともに送信するファイルの配列
bcc	String	BCC へのメールアドレスのカンマ区切りリスト
cc	String	CC に送信するメールアドレスのカンマ区切りリスト
from	String	メールの送信元アドレス。GmailApp.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	デフォルトの返信先アドレスとして使用するメールアドレス（デフォルト: ユーザーのメールアドレス）
subject	String	メールの件名（半角 250 文字、全角 120 文字まで）。

復路

GmailMessage - このメッセージは、チェーンに役立ちます。

承認

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

• https://mail.google.com/

関連ドキュメント

• reply(body)
• replyAll(body)
• replyAll(body, options)

---

replyAll(body)

返信先アドレスとこのメッセージのすべての受信者を使用して送信者に返信します。メール（ヘッダーを含む）のサイズは割り当て上限があります。

// Respond to all recipients (except bcc'd) of last email in thread with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.replyAll("Got your message");

パラメータ

名前	型	説明
body	String	メールの本文。

復路

GmailMessage - このメッセージはチェーンに役立ちます。

承認

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

• https://mail.google.com/

関連ドキュメント

• reply(body)
• reply(body, options)
• replyAll(body, options)

---

replyAll(body, options)

このメッセージの送信元に対し、返信先アドレスとすべての受信者を、オプションの引数とともに返します。

このメールには、書式なしテキストと HTML 本文の両方を含めることができます。メール（ヘッダーを含む）のサイズは割り当て上限があります。

// Respond with HTML body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
messageThread.replyAll("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  noReply: true
});

パラメータ

名前	型	説明
body	String	メールの本文。
options	Object	下記の詳細なパラメータを指定する JavaScript オブジェクト。

拡張パラメータ

名前	型	説明
attachments	BlobSource[]	メールとともに送信するファイルの配列
bcc	String	BCC へのメールアドレスのカンマ区切りリスト
cc	String	CC に送信するメールアドレスのカンマ区切りリスト
from	String	メールの送信元アドレス。GmailApp.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	デフォルトの返信先アドレスとして使用するメールアドレス（デフォルト: ユーザーのメールアドレス）
subject	String	メールの件名（半角 250 文字、全角 120 文字まで）。

復路

GmailMessage - このメッセージは、チェーンに役立ちます。

承認

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

• https://mail.google.com/

関連ドキュメント

• reply(body)
• reply(body, options)
• replyAll(body)

---

star()

メッセージにスターを付けます。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.star(); // Star the message

復路

GmailMessage - チェーンに役立つ GmailMessage。

承認

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

• https://mail.google.com/

関連ドキュメント

• unstar()

---

unstar()

メッセージのスターを外します。

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.unstar(); // Unstar the message

復路

GmailMessage - チェーンに役立つ GmailMessage。

承認

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

• https://mail.google.com/

関連ドキュメント

• star()