Class GmailMessage

GmailMessage

ユーザーの Gmail アカウントのメール。

メソッド

メソッド	戻り値の型	概要
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 をレンダリングできるデバイスでは 必須の body 引数です。HTML 本文にオプションの inlineImages フィールドを追加できます。 メールにインライン画像を使用して
inlineImages	Object	イメージキーからのマッピングを含む JavaScript オブジェクト （String）から画像データ（BlobSource）へ。htmlBody パラメータが使用され、<img src="cid:imageKey" /> 形式でこれらの画像への参照が含まれていることを前提としています。
name	String	メールの送信者の名前（デフォルト: ユーザー名）
replyTo	String	デフォルトの返信先アドレスとして使用するメールアドレス （デフォルト: ユーザーのメールアドレス）。
subject	String	メールの新しい件名（最大 250 文字）。

戻る

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 をレンダリングできるデバイスでは 必須の body 引数です。HTML 本文にオプションの inlineImages フィールドを追加できます。 メールにインライン画像を使用して
inlineImages	Object	イメージキーからのマッピングを含む JavaScript オブジェクト （String）から画像データ（BlobSource）へ。htmlBody パラメータが使用され、<img src="cid:imageKey" /> 形式でこれらの画像への参照が含まれていることを前提としています。
name	String	メールの送信者の名前（デフォルト: ユーザー名）
replyTo	String	デフォルトの返信先アドレスとして使用するメールアドレス （デフォルト: ユーザーのメールアドレス）。
subject	String	メールの新しい件名（最大 250 文字）。

戻る

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 をレンダリングできるデバイスでは 必須の body 引数です。HTML 本文にオプションの inlineImages フィールドを追加できます。 メールにインライン画像を使用して
inlineImages	Object	イメージキーからのマッピングを含む JavaScript オブジェクト （String）から画像データ（BlobSource）へ。htmlBody パラメータが使用され、<img src="cid:imageKey" /> 形式でこれらの画像への参照が含まれていることを前提としています。
name	String	メールの送信者の名前（デフォルト: ユーザー名）
noReply	Boolean	true: メールを一般的な送信元から送信する場合は、 受信者がメールに返信しないように、返信なしの E メール・アドレスを使用する。このオプションは Google Workspace アカウントでのみ可能で、Gmail ユーザーは対象外
replyTo	String	デフォルトの返信先アドレスとして使用するメールアドレス （デフォルト: ユーザーのメールアドレス）。
subject	String	メールの新しい件名（最大 250 文字）。

戻る

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 をレンダリングできるデバイスでは 必須の body 引数です。HTML 本文にオプションの inlineImages フィールドを追加できます。 メールにインライン画像を使用して
inlineImages	Object	イメージキーからのマッピングを含む JavaScript オブジェクト （String）から画像データ（BlobSource）へ。htmlBody パラメータが使用され、<img src="cid:imageKey" /> 形式でこれらの画像への参照が含まれていることを前提としています。
name	String	メールの送信者の名前（デフォルト: ユーザー名）
noReply	Boolean	true: メールを一般的な送信元から送信する場合は、 受信者がメールに返信しないように、返信なしの E メール・アドレスを使用する。このオプションは Google Workspace アカウントでのみ可能で、Gmail ユーザーは対象外
replyTo	String	デフォルトの返信先アドレスとして使用するメールアドレス （デフォルト: ユーザーのメールアドレス）。
subject	String	メールの新しい件名（最大 250 文字）。

戻る

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 をレンダリングできるデバイスでは 必須の body 引数です。HTML 本文にオプションの inlineImages フィールドを追加できます。 メールにインライン画像を使用して
inlineImages	Object	イメージキーからのマッピングを含む JavaScript オブジェクト （String）から画像データ（BlobSource）へ。htmlBody パラメータが使用され、<img src="cid:imageKey" /> 形式でこれらの画像への参照が含まれていることを前提としています。
name	String	メールの送信者の名前（デフォルト: ユーザー名）
noReply	Boolean	true: メールを一般的な送信元から送信する場合は、 受信者がメールに返信しないように、返信なしの E メール・アドレスを使用する。このオプションは Google Workspace アカウントでのみ可能で、Gmail ユーザーは対象外
replyTo	String	デフォルトの返信先アドレスとして使用するメールアドレス （デフォルト: ユーザーのメールアドレス）。
subject	String	メールの新しい件名（最大 250 文字）。

戻る

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