ユーザーの 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/
関連ドキュメント
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: "another@example.com" });
パラメータ
名前 | 型 | 説明 |
---|---|---|
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/
関連ドキュメント
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/
関連ドキュメント
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: "another@example.com" });
パラメータ
名前 | 型 | 説明 |
---|---|---|
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/
関連ドキュメント
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("recipient1@example.com,recipient2@example.com");
パラメータ
名前 | 型 | 説明 |
---|---|---|
recipient | String | メールアドレスのカンマ区切りのリスト。 |
リターン
GmailMessage
- このメッセージ。チェーン化に役立ちます。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
forward(recipient, options)
このメールを新しい受信者に転送します。任意の引数を指定できます。
メールには、書式なしテキストと HTML 本文の両方を含めることができます。メールのサイズ(ヘッダーを含む)には割り当てが制限されています。
var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; message.forward("recipient1@example.com,recipient2@example.com", { cc: "myboss@example.com", bcc: "mybosses-boss@example.com,vp@example.com" });
パラメータ
名前 | 型 | 説明 |
---|---|---|
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/
関連ドキュメント
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/
関連ドキュメント
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/
関連ドキュメント
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/
関連ドキュメント
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/
関連ドキュメント
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/
関連ドキュメント
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/
関連ドキュメント
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/
関連ドキュメント
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/
関連ドキュメント
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/
関連ドキュメント
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/
関連ドキュメント
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/
関連ドキュメント
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)
返信先アドレスを使用して、このメッセージの送信者に返信します。オプションの引数を指定します。
メールには、書式なしテキストと 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 文字)。 |
リターン
GmailMessage
- このメッセージ。チェーン化に役立ちます。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
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/
関連ドキュメント
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 文字)。 |
リターン
GmailMessage
- このメッセージ。チェーン化に役立ちます。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープ、または関連する REST API の適切なスコープによる承認が必要です。
-
https://mail.google.com/
関連ドキュメント
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()
メッセージのスターを外します。
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/