Class GmailMessage

GmailMessage

ユーザーの 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 と C をカンマ区切りで取得します。
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	画像キー（String）から画像データ（BlobSource）へのマッピングを含む JavaScript オブジェクト。これは、htmlBody パラメータが使用され、これらの画像への参照が <img src="cid:imageKey" /> 形式で含まれていることを前提としています。
name	String	メールの送信者の名前（デフォルト: ユーザーの名前）
replyTo	String	デフォルトの返信先アドレスとして使用するメールアドレス（デフォルト: ユーザーのメールアドレス）
subject	String	メールの新しい件名

戻る

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	画像キー（String）から画像データ（BlobSource）へのマッピングを含む JavaScript オブジェクト。これは、htmlBody パラメータが使用され、これらの画像への参照が <img src="cid:imageKey" /> 形式で含まれていることを前提としています。
name	String	メールの送信者の名前（デフォルト: ユーザーの名前）
replyTo	String	デフォルトの返信先アドレスとして使用するメールアドレス（デフォルト: ユーザーのメールアドレス）
subject	String	メールの新しい件名

戻る

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	画像キー（String）から画像データ（BlobSource）へのマッピングを含む JavaScript オブジェクト。これは、htmlBody パラメータが使用され、これらの画像への参照が <img src="cid:imageKey" /> 形式で含まれていることを前提としています。
name	String	メールの送信者の名前（デフォルト: ユーザーの名前）
noReply	Boolean	true: 受信者がメールに返信しないように、返信しない汎用的なメールアドレスからメールを送信する場合に必要です。このオプションは、Gmail ユーザーではなく、Google Workspace アカウントでのみ使用可能です。
replyTo	String	デフォルトの返信先アドレスとして使用するメールアドレス（デフォルト: ユーザーのメールアドレス）
subject	String	メールの新しい件名

戻る

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 と C をカンマ区切りで取得します。

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)

RFC2822 ヘッダーを含む特定のヘッダーの値を取得します。

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	画像キー（String）から画像データ（BlobSource）へのマッピングを含む JavaScript オブジェクト。これは、htmlBody パラメータが使用され、これらの画像への参照が <img src="cid:imageKey" /> 形式で含まれていることを前提としています。
name	String	メールの送信者の名前（デフォルト: ユーザーの名前）
noReply	Boolean	true: 受信者がメールに返信しないように、返信しない汎用的なメールアドレスからメールを送信する場合に必要です。このオプションは、Gmail ユーザーではなく、Google Workspace アカウントでのみ使用可能です。
replyTo	String	デフォルトの返信先アドレスとして使用するメールアドレス（デフォルト: ユーザーのメールアドレス）
subject	String	メールの新しい件名

戻る

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	画像キー（String）から画像データ（BlobSource）へのマッピングを含む JavaScript オブジェクト。これは、htmlBody パラメータが使用され、これらの画像への参照が <img src="cid:imageKey" /> 形式で含まれていることを前提としています。
name	String	メールの送信者の名前（デフォルト: ユーザーの名前）
noReply	Boolean	true: 受信者がメールに返信しないように、返信しない汎用的なメールアドレスからメールを送信する場合に必要です。このオプションは、Gmail ユーザーではなく、Google Workspace アカウントでのみ使用可能です。
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()