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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 文字以内）。

戻る

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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 文字以内）。

戻る

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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 形式の本文の両方を含めることができます。メールのサイズ（ヘッダーを含む）が割り当て上限を超えている。

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 文字以内）。

戻る

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	返された Blob 添付ファイルの配列にインライン画像を含める場合は true（デフォルトは true）。
includeAttachments	Boolean	返された Blob 添付ファイルの配列に通常の（インラインでない）添付ファイルを含める場合は true（デフォルトは true）。

戻る

GmailAttachment[] - このメッセージの Blob 添付ファイルの配列。

承認

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

• https://mail.google.com/

---

getBcc()

このメッセージで Bcc に指定された受信者のカンマ区切りリストを取得します。

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 コンテンツを取得します。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 に追加された受信者のカンマ区切りリストを取得します。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 ヘッダーの値を取得します。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox.
const 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 を取得します。

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

戻る

String - メッセージ ID。

---

getPlainBody()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()

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

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

戻る

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

承認

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

• https://mail.google.com/

関連情報

• getAttachments()

---

getThread()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is draft? ${message.isDraft()}`);

戻る

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

承認

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

• https://mail.google.com/

---

isInChats()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is a chat? ${message.isInChats()}`);

戻る

Boolean - このメッセージがチャットかどうか。

---

isInInbox()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 を返します。

const thread = GmailApp.getPriorityInboxThreads(
    0, 1)[0];  // Get first thread in priority inbox
const messages = thread.getMessages();
for (let 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()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in the trash? ${message.isInTrash()}`);

戻る

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

---

isStarred()

このメッセージにスターが付いているかどうかを取得します。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is starred? ${message.isStarred()}`);

戻る

Boolean - このメッセージにスターが付いているかどうか。

---

isUnread()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is unread? ${message.isUnread()}`);

戻る

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

承認

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

• https://mail.google.com/

---

markRead()

メールを既読にします。

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

戻る

GmailMessage - この GmailMessage。チェーン処理に便利です。

承認

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

• https://mail.google.com/

関連情報

• isUnread()

---

markUnread()

メッセージを未読としてマークします。

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

戻る

GmailMessage - この GmailMessage。チェーン処理に便利です。

承認

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

• https://mail.google.com/

関連情報

• isUnread()

---

moveToTrash()

メッセージをゴミ箱に移動します。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 から再読み込みします（ラベルや既読状態などが変更された場合に便利です）。

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 文字以内）。

戻る

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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.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 文字以内）。

戻る

GmailMessage - チェーンに役立つこのメッセージ。

承認

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

• https://mail.google.com/

関連情報

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

---

star()

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

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

戻る

GmailMessage - この GmailMessage。チェーン処理に便利です。

承認

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

• https://mail.google.com/

関連情報

• unstar()

---

unstar()

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

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

戻る

GmailMessage - この GmailMessage。チェーン処理に便利です。

承認

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

• https://mail.google.com/

関連情報

• star()