【GAS】Ｇメールのスター機能まとめ【サンプルソース付】

GAS開発者向けにＧメールのスター機能をすべてまとめました。

重要なメールには、スターを付けてを目立たせることができますね。

後から見返したり、返信する必要のあるメールを整理するには必須の機能です。いろんな種類があります。

スターに関するメソッドをすべて載せてます。少しでも参考になれば幸いです。

ＧメールAPPクラス[GmailApp]のスター取得
Ｇメールメッセージクラス[GmailMessage]
1. スター追加[star()]
2. スター解除[unstar()]
最後に

ＧメールAPPクラス[GmailApp]のスター取得

Ｇメールのスター取得・追加・解除メソッドです。

スター付のスレッド取得[getStarredThreads()]

getStarredThreads()
ラベルに関係なく、すべてのスター付きスレッドを取得します。

すべてのスレッドのサイズが大きすぎてシステムが処理できない場合、この呼び出しは失敗します。スレッドサイズが不明で、潜在的に非常に大きい場合は、「paged」呼び出しを使用し、各呼び出しで取得するスレッドの範囲を指定してください。

function getStarredThreadsSample() {
  // スター付きスレッドの数を記録します
  Logger.log("＃スター付きスレッド：" + GmailApp.getStarredThreads().length);
}

Return
GmailThread[] - スター付きのGmailスレッドの配列。

スター付のスレッド範囲取得[getStarredThreads(開始, 最大)]

getStarredThreads(start, max)
ラベルに関係なく、スター付きスレッドの範囲を取得します。

function getStarredThreadsSample() {
  // スター付きスレッドの数を最大5まで記録します
  Logger.log("＃スター付きスレッド：" + GmailApp.getStarredThreads(0, 5).length);
}

Parameters
名前	タイプ	説明
start	Integer	取得する最初のスレッドのインデックス
max	Integer	取得するスレッドの最大数

Return
GmailThread[] - スター付きのGmailスレッドの配列。

スター付の未読スレッド数取得[getStarredUnreadCount()]

getStarredUnreadCount()
スター付きの未読スレッドの数を取得します。

function getStarredUnreadCountSample() {
  Logger.log("＃未読およびスター付き：" + GmailApp.getStarredUnreadCount());
}

Return
Integer - 未読メッセージがあるスター付きスレッドの数。

スター追加[starMessage(メッセージ)]

starMessage(message)
このメッセージにスターを追加して、メッセージを強制的に更新します。

function starMessageSample() {
  // 受信トレイの最初のスレッドの最初のメッセージにスターを付けます
  var firstThread = GmailApp.getInboxThreads(0,1)[0];
  var message = firstThread.getMessages()[0];
  GmailApp.starMessage(message);
}

Parameters
名前	タイプ	説明
message	GmailMessage	スターへのメッセージ。

Return
GmailApp - 連鎖用のGmailサービス。

スター一括追加[starMessages(メッセージ's)]

starMessages(messages)
これらのメッセージに星を追加し、メッセージを強制的に更新します。

function starMessagesSample() {
  // 受信トレイの最初のスレッドの最初の3つのメッセージにスターを付けます
  var firstThread = GmailApp.getInboxThreads(0,1)[0];
  var coupleOfMessages = firstThread.getMessages().slice(0, 3);
  GmailApp.starMessages(coupleOfMessages);
}

Parameters
名前	タイプ	説明
messages	GmailMessage[]	スターを付けるメッセージの配列。

Return
GmailApp - 連鎖用のGmailサービス。

スター解除[unstarMessage(メッセージ)]

unstarMessage(message)
このメッセージからスターを削除し、メッセージを強制的に更新します。

function unstarMessageSample() {
  // 受信トレイの最初のスレッドの最初のメッセージのスターを外します
  var firstThread = GmailApp.getInboxThreads(0,1)[0];
  var message = firstThread.getMessages()[0];
  GmailApp.unstarMessage(message);
}

Parameters
名前	タイプ	説明
message	GmailMessage	スターを外すメッセージ。

Return
GmailApp - 連鎖用のGmailサービス。

スター一括解除[unstarMessages(メッセージ's)]

unstarMessages(messages)
これらのメッセージから星を削除し、メッセージを強制的に更新します。

function unstarMessagesSample() {
  // 受信トレイの最初のスレッドの最初の3つのメッセージのスターを外します
  var firstThread = GmailApp.getInboxThreads(0,1)[0];
  var coupleOfMessages = firstThread.getMessages().slice(0, 3);
  GmailApp.unstarMessages(coupleOfMessages);
}

Parameters
名前	タイプ	説明
messages	GmailMessage[]	スターを外すメッセージの配列。

Return
GmailApp - 連鎖用のGmailサービス。

スター確認[isStarred()]

isStarred()
このメッセージにスターを付けるかどうかを取得します。

function isStarredSample() {
  var thread = GmailApp.getInboxThreads(0,1)[0]; // 受信トレイで最初のスレッドを取得します
  var message = thread.getMessages()[0]; // 最初のメッセージを取得
  Logger.log("スター付き？ " + message.isStarred());
}

Return
Boolean - このメッセージにスターを付けるかどうか。

Ｇメールメッセージクラス[GmailMessage]

Ｇメールメッセージのスター追加・解除メソッドです。

スター追加[star()]

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

function starSample() {
  var thread = GmailApp.getInboxThreads(0,1)[0]; // 受信トレイで最初のスレッドを取得します
  var message = thread.getMessages()[0]; // 最初のメッセージを取得
  message.star(); // メッセージにスターを付けます
}

Return
GmailApp - 連鎖用のGmailメッセージ。

スター解除[unstar()]

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

function unstarSample() {
  var thread = GmailApp.getInboxThreads(0,1)[0]; // 受信トレイで最初のスレッドを取得します
  var message = thread.getMessages()[0]; // 最初のメッセージを取得
  message.unstar(); // メッセージのスターを外します
}

Return
GmailApp - 連鎖用のGmailメッセージ。

最後に

Ｇメールのスター機能のまとめをご紹介させていただきました.

スプレッドシートと組み合わせるとさらに効果的です。

必要に応じて、有益な情報でさらに更新していきたいと思います。

プログラミングスキルを向上させるためには、本を読むだけでは脳にインプットされませんね。

実際に手を動かしてアウトプットしまくるのが一番の近道だと思います。

実際にサンプルソースをコピーして実行した結果がどうなるかを体験してみてください。

自分なりのアレンジを加えたり、なぜエラーになるのかを考え、何度も試行錯誤して問題を解決しまくり、着実に理解しながらスキルを向上させていきましょう。

GASはExcelVBAとはかなり違いますが、ベースとなっているJavaScriptは覚えて損はないプログラミング言語なのでショートカットキーなどと組み合わせてぜひ活用してみてください。

Googleスプレッドシート全ショートカットキー一覧はこちら↓↓↓

Googleスプレッドシートの使い方や機能がわかるショートカットキー全まとめ一覧【初心者こそ必見】

表計算ソフトとして、まだまだExcelのシェア率は高いですが、GoogleスプレッドシートにはExcelにはない超強力な関数があったり、Excelとは違って常に最新版を無料で使用できます。なにより、インターネットを使ったオンライン...

ショートカットキー一覧にもGASメソッドを載せています。どの操作からどのメソッドが呼ばれるのかイメージしてください。