Google Apps Script Documentation - Gmail Services

Googleを追いかけろ！

home >> Gmail Services >> Class GmailMessage

Class GmailMessage
.. Gmailのメッセージ
* Gmail Service

class GmailMessage : Members
member	Type	説明
forward	GmailMessage	このメッセージを新しい受信者に転送する
getAttachments	Blob[ ]	このメッセージからすべての添付ファイルを取得する
getBody	Stirng	このメール本文から内容を取得する
getCc	Sring	このメールのCC受信者を取得する
getDate	Date	このメッセージの日付を取得する
getFrom	String	このメッセージの送信者を取得する
getId	String	このメッセージのIDを取得する
getReplyTo	String	このメールの返信アドレス（通常は送信者）を取得する
getSubject	String	このメールの表題を取得する
getThread	GmailThread	このメールを含むスレッドを取得する
getTo	String	このメールの送信先アドレスを取得する
isInChats	Boolean	このメールのチャットのラベルの有無をチェックする
isInInbox	Boolean	このメールが受信箱内かチェックする
isInTrash	Boolean	このメールがゴミ箱内かチェックする
isStarred	Boolean	このメールがスター付きかチェックする
isUnread	Boolean	このメールが未読かチェックする
markRead	GmailMessage	このメールを既読としてマークする
markUnread	GmailMessage	このメールを未読としてマークする
moveToTrash	GmailMessage	このメールをゴミ箱に移動する
refresh	GmailMessage	メッセージと関連付けられたラベルや開封の有無を更新をする
star	GmailMessage	このメールにスターを付ける
unstar	GmailMessage	このメールのスターを取り消す
reply	GmailMessage	replyToのアドレスを利用してこのメッセージの送信者に返信する
replyAll	GmailMessage	このメッセージの送信者とメッセージの受信者すべてに返信（replyToのアドレスを利用）する

forward(recipient, optAdvancedArgs)

このメッセージを新しい受信者に転送する
メールはプレーンテキストとhtml本文を含めることが可能。メールのトータルサイズ（添付ファイルを除きすべてのヘッダーを含む）は20kbを超えてはならない。
参考；reply, replyAll

Arguments :
name	Type	説明
recipient	String	カンマ区切りによるメールアドレス
optAdvancedArgs	Object	未定義

Advanced Arguments :
name	Type	説明
bcc	String	カンマ区切りによるBCCのメールアドレス
cc	String	カンマ区切りによるCCのメールアドレス
htmlBody	String	セットされた場合は、HTMLをレンダリングできるディバイスが必要とされるメール本文の引数の代わりに利用する
name	String	メール送信者の名前；デフォルトはユーザーネーム
noReply	Boolean	メールへの応答を避けるために無応答なメールアドレスを使用
replyTo	String	送信されたメッセージへ返信するためのメールアドレス
attachments	Array	メールにで送信されるファイル；それぞれのアイテムはJavaScriptオブジェクトを含む次のプロパティを持つ - 文字列,ファイルネーム, mimeType文字列 (オプション),文字列コンテンツ

戻り値 :
Type	説明
GmailThread	このメッセージ（連結時に有効）

サンプル :
// forward first inbox thread to recipient1 & recipient2, both @example.com var firstThread = GmailApp.getInboxThreads(0,1)[0]; firstThread.forward("recipient1@example.com,recipient2@example.com");

サンプル :
var firstThread = GmailApp.getInboxThreads(0,1)[0]; firstThread.forward("recipient1@example.com,recipient2@example.com", { cc: "myboss@example.com", bcc: "mybosses-boss@example.com,vp@example.com");

getAttachments()

このメッセージからすべての添付ファイルを取得する
参考；getBody, getSubject

戻り値 :
Type	説明
Blob[ ]	Blobの添付配列

getBody()

このメール本文から内容を取得する
参考；getAttachments, getSubject

戻り値 :
Type	説明
String	このメールメッセージの本文内容

サンプル :
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

getCc()

このメールのCC受信者を取得する
参考；getReplyTo, getTo

戻り値 :
Type	説明
String	CCでメールを受信した人（* cc'dはcarbon copiedの略）

サンプル :
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

getDate()

このメッセージの日付を取得する

戻り値 :
Type	説明
Date	このメッセージの日付

サンプル :
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 of the message

getFrom()

このメッセージの送信者を取得する
参考；getReplyTo

戻り値 :
Type	説明
String	メッセージ送信者のメールアドレス

サンプル :

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

getId()

このメッセージのIDを取得する

戻り値 :
Type	説明
GmailMessage[ ]	このメッセージの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

getReplyTo()

このメールの返信アドレス（通常は送信者）を取得する
参考；getFrom, getCc

戻り値 :
Type	説明
String	返信アドレス

サンプル :
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

getSubject()

このスレッドが重要のマーク付きかチェックする
参考；getBody, getAttachments

戻り値 :
Type	説明
String	このメッセージの表題

サンプル :
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

getThread()

このメールを含むスレッドを取得する

戻り値 :
Type	説明
GmailThread	このメッセージを含むスレッド

サンプル :

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

getTo()

このメールの送信先アドレスを取得する
参考；getCc,

戻り値 :
Type	説明
String	このメールのアドレス

サンプル :
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 to address of message

isInChats()

このメールのチャットのラベルの有無をチェックする
参考；isInInbox, isInTrash, isStarred, isUnread,

戻り値 :
Type	説明
Boolean	チャットラベルの有無をtrueかfalseで判定

サンプル :
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());

isInInbox()

このメールが受信箱内かチェックする
参考；isInChats, isInTrash, isStarred, isUnread

戻り値 :
Type	説明
Boolean	受信箱内のメールの有無をtrueかfalseで判定

サンプル :
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());

isInTrash()

このメールがゴミ箱内かチェックする
参考；isInChats, isInInbox, isStarred, isUnread,

戻り値 :
Type	説明
Boolean	このメールのゴミ箱内の有無をtrueかfalseで判定

サンプル :
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());

isStarred()

このメールがスター付きかチェックする
参考；isInChats, isInInbox, isInTrash, isUnread

戻り値 :
Type	説明
Boolean	このメールのスターマークの有無をtrueかfalseで判定

サンプル :
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());

isUnread()

このメールが未読かチェックする
参考；isInChats, isInTrash, isStarred

戻り値 :
Type	説明
Boolean	このメールが未読かどうかをtrueかfalseで判定

サンプル :

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());
// obviously, if you want to see if it's read, just look at !message.isUnread()

markRead()

このメールを既読としてマークする
参考；markUnread, isUnread

戻り値 :
Type	説明
GmailMessage	このメール（連結時に有効）

サンプル :
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

markUnread()

このメールを未読としてマークする
参考；markRead, isUnread

戻り値 :
Type	説明
GmailMessage	このメール（連結時に有効）

サンプル :
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

moveToTrash()

このメールをゴミ箱へ移動する
参考；isInTrash

戻り値 :
Type	説明
GmailMessage	このメール（連結時に有効）

サンプル :
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

refresh()

メッセージと関連付けられたラベルや開封の有無を更新をする

戻り値 :
Type	説明
GmailMessage	このメール（連結時に有効）

サンプル :

"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

star()

このメールにスターを付ける
参考；unstar

戻り値 :
Type	説明
GmailMessage	このメール（連結時に有効）

サンプル :
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

unstar()

このメールのスターを取り消す
参考；star

戻り値 :
Type	説明
GmailMessage	このメール（連結時に有効）

サンプル :
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

reply(body, optAdvancedArgs)

replyToのアドレスを利用してこのメッセージの送信者に返信する
メールはプレーンテキストとhtml本文を含めることが可能。メールのトータルサイズ（添付ファイルを除きすべてのヘッダーを含む）は20kbを超えてはならない。
参考；replyAll

Arguments :
name	Type	説明
body	String	メール本文
optAdvancedArgs	Object	未定義

Advanced Arguments :
name	Type	説明
htmlBody	String	セットされた場合は、HTMLをレンダリングできるディバイスが必要とされるメール本文の引数の代わりに利用する
name	String	メール送信者の名前；デフォルトはユーザーネーム
noReply	Boolean	メールへの応答を避けるために無応答なメールアドレスを使用
replyTo	String	送信されたメッセージへ返信するためのメールアドレス
attachments	Array	メールにで送信されるファイル；それぞれのアイテムはJavaScriptオブジェクトを含む次のプロパティを持つ - 文字列,ファイルネーム, mimeType文字列 (オプション),文字列コンテンツ

戻り値 :
Type	説明
GmailMessage	このメール（連結時に有効）

サンプル :
// respond to author of message with acknowlegment var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; message.reply("Got your message");

サンプル :

// respond with html body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages[0];
messageThread.reply("incapable of html", {
    htmlBody: "some html body text",
    noReply: true
  }
);

replyAll(body, optAdvancedArgs)

このメッセージの送信者とメッセージの受信者すべてに返信（replyToのアドレスを利用）する
メールはプレーンテキストとhtml本文を含めることが可能。メールのトータルサイズ（添付ファイルを除きすべてのヘッダーを含む）は20kbを超えてはならない。
参考；reply

Arguments :
name	Type	説明
body	String	メール本文
optAdvancedArgs	Object	未定義

Advanced Arguments :
name	Type	説明
htmlBody	String	セットされた場合は、HTMLをレンダリングできるディバイスが必要とされるメール本文の引数の代わりに利用する
name	String	メール送信者の名前；デフォルトはユーザーネーム
noReply	Boolean	メールへの応答を避けるために無応答なメールアドレスを使用
replyTo	String	送信されたメッセージへ返信するためのメールアドレス
attachments	Array	メールにで送信されるファイル；それぞれのアイテムはJavaScriptオブジェクトを含む次のプロパティを持つ - 文字列,ファイルネーム, mimeType文字列 (オプション),文字列コンテンツ

戻り値 :
Type	説明
GmailMessage	このスレッド（連結時に有効）

サンプル :

// 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");

サンプル :

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