今日からGmailで使えるGASのコード一覧

GmailAppの概要

GmailAppとは、Google Apps Scriptでカレンダーの操作を行う際に利用するコードのことですが、GmailAppに用意されているメソッドでは、次のような情報にアクセスできます。

• 受信メールの情報取得
• 受信メールの編集
• 未読メール数の取得
• 下書きメールの作成
• メールの送信
• ラベルの編集
• スターの編集

クラス名一覧

GmailApp	GmailAttachment	GmailDraft
GmailLabel	GmailMessage	GmailThread

※クリックすると対象場所にジャンプします

クラス別メソッド名一覧

Class GmailApp

createDraft	GmailDraft	下書きを作成
createLabel	GmailLabel	ラベルを作成
deleteLabel	GmailApp	ラベルを削除
getAliases	String[]	エイリアスを取得
getChatThreads	GmailThreads[]	全てのチャットスレッドを配列で取得
getDraft	GmailDraft	IDで下書きメッセージを取得
getDraftMessages	GmailMessage[]	全ての下書きメッセージを配列で取得
getDrafts	GmailDraft[]	全ての下書きを配列で取得
getInboxThreads	GmailThread[]	受信トレイ内の全てのスレッドを配列で取得
getInboxUnreadCount	Integer	受信トレイ内の未読メール数を取得
getMessageById	GmailMessage	IDでメッセージを取得
getMessagesForThread(s)	GmailMessage[]	指定のスレッド内の全てのメッセージを配列で取得
getpriorityInboxThreads	GmailThread[]	重要内の全てのスレッドを配列で取得
getSpamThreads	GmailThread[]	迷惑メール内の全てのスレッドを配列で取得
getSpamUnreadCount	Integer	迷惑メール内の未読メール数を取得
getStarredThreads	GmailThread[]	スター付きの全てのスレッドを配列で取得
getStarredUnreadCount	Integer	スター付きの未読メール数を取得
getThreadById	GmailThread	IDでスレッドを取得
getTrashThreads	GmailThread[]	ゴミ箱内の全てのスレッドを配列で取得
getUserLabelByName	GmailLabel	ラベル名に一致するラベルを取得
getUserLabels	GmailLabel[]	ユーザーが作成したラベルを配列で取得
markMessageRead	GmailApp	メールを既読にする
markMessageUnread	GmailApp	メールを未読にする
markThread(s)Important	GmailApp	スレッドを重要度高にする
markThread(s)Read	GmailApp	スレッドを既読にする
markThread(s)Unimportant	GmailApp	スレッドの重要度高を解除する
markThread(s)Unread	GmailApp	スレッドを未読にする
moveToTrash	GmailApp	ゴミ箱に移動する
moveThread(s)To	GmailApp	スレッドを移動する
refreshMessage(s)	GmailApp	メールを更新する
refreshThread(s)	GmailApp	スレッドを更新する
search	GmailThread[]	メールを検索する
sendEmail	GmailApp	メールを送信する
setCurrentMessageAccessToken	Void	アクセストークンを設定する
starMessage(s)	GmailApp	メールにスターを付ける
unstarMessage(s)	GmailApp	メールのスターをはずす

Class GmailAttachment

メソッド名	タイプ	簡単な説明
copyBlob	Blob	添付ファイルをコピー
getAs	Blob	添付ファイルを指定の形式に変換
getBytes	Byte[]	添付ファイルのバイト数を取得
getContentType	String	添付ファイルのファイル形式を取得
getDataAsString	String	データを文字列で取得
getName	String	添付ファイル名を取得
getSize	Integer	添付ファイルのサイズを取得
isGoogleType	Boolean	Googleファイルかどうか確認
setBytes	Blob	バイト数を設定
setContentType	Blob	ファイル形式を設定
setContentTypeFromExtension	Blob	拡張子からファイル形式を設定
setDataFromString	Blob	文字列からデータを設定
setName	Blob	添付ファイル名を設定

Class GmailDraft

メソッド名	タイプ	簡単な説明
deleteDraft	Void	下書きを削除
getId	String	下書きのIDを取得
getMessage	GmailMessage	下書きメッセージを取得
getMessageId	String	下書きメッセージのIDを取得
send	GmailMessage	下書きを送信
update	GmailDraft	下書きを更新

Class GmailLabel

メソッド名	タイプ	簡単な説明
addToThread(s)	GmailLabel	ラベルをスレッドに追加
deleteLabel	Void	ラベルを削除
getName	String	ラベル名を取得
getThreads	GmailThread[]	ラベル名と一致するスレッドを取得
getUnreadCount	Integer	ラベルの未読メール数を取得
removeFromThread(s)	GmailLabel	１つのスレッドからラベルを取り除く

Class GmailMessage

メソッド名	タイプ	簡単な説明
createDraftReply	GmailDraft	返信用アドレス宛に返信用の下書きを作成
createDraftReplyAll	GmailDraft	全ての宛先宛に返信用の下書きを作成
forward	GmailMessage	他の人にメールを転送
getAttachments	GmailAttachment[]	すべての添付ファイルを配列で取得
getBcc	String	メールのBCC宛先を取得
getBody	String	メールの本文を取得
getCc	String	メールのCC宛先を取得
getDate	Date	メールの日時を取得
getFrom	String	メールの送信者を取得
getId	String	メールのIDを取得
getPlainBody	String	メールの本文を取得 (html除く)
getRawContent	String	メールの本文を取得 (html含む)
getReplyTo	String	メールの返信用アドレスを取得
getSubject	String	メールの件名を取得
getThread	GmailThread	メールのスレッドを取得
getTo	String	メールのメールの送信先を取得
isDraft	Boolean	下書きかどうか確認
isInChats	Boolean	チャットかどうか確認
isInInbox	Boolean	受信ボックスにあるかどうか確認
isInPriorityInbox	Boolean	重要にあるかどうか確認
isInTrash	Boolean	ゴミ箱にあるかどうか確認
isStarred	Boolean	スターの有無を確認
isUnread	Boolean	未読かどうか確認
markRead	GmailMessage	既読にする
markUnread	GmailMessage	未読にする
moveToTrash	GmailMessage	ゴミ箱に移動
refresh	GmailMessage	メッセージを更新
reply	GmailMessage	返信用アドレス宛に返信する
replyAll	GmailMessage	全ての宛先に返信する
star	GmailMessage	メールにスターを付ける
unstar	GmailMessage	メールからスターをはずす

GClass GmailThread

メソッド名	タイプ	簡単な説明
addLabel	GmailThread	ラベルを付ける
createDraftReply	GmailDraft	返信用アドレス宛に下書きを作成
createDraftReplyAll	GmailDraft	全ての宛先宛に下書きを作成
getFirstMessageSubject	String	最初の件名を取得
getId	String	スレッドのIDを取得
getLabels	GmailLabel[]	スレッドのラベルを取得
getLastMessageDate	Date	最終メールの日時を取得
getMessageCount	Integer	メール数を取得
getMessages	GmailMessage[]	メールを取得
getPermaLink	String	パーマリンクを取得
hasStarredMessages	Boolean	スター付きメールがあるかどうか確認
isImportant	Boolean	重要度高メールがあるかどうか確認
isInChats	Boolean	チャッ卜かどうか確認
isInInbox	Boolean	受信ボックスにあるかどうか確認
isInPriorityInbox	Boolean	重要にあるかどうか確認
isInSpam	Boolean	迷惑メールにあるかどうか確認
isInTrash	Boolean	ゴミ箱にあるかどうか確認
isUnread	Boolean	未読かどうか確認
markImportant	GmailThread	重要度高に設定
markRead	GmailThread	既読にする
markUnimportant	GmailThread	重要度高を解除
markUnread	GmailThread	未読にする
moveToArchive	GmailThread	アーカイブに移動
moveToInbox	GmailThread	受信ボックスに移動
moveToSpam	GmailThread	迷惑メールに移動
moveToTrash	GmailThread	ゴミ箱に移動
refresh	GmailThread	スレッドを更新
removeLabel	GmailThread	ラベルをはずす
reply	GmailThread	返信用アドレス宛に返信する
replyAll	GmailThread	全ての宛先に返信する