2012年8月5日日曜日

受信トレイのスレッドを取得する

Gmail の受信トレイにあるスレッド (オブジェクト) を取得するには、GmailApp クラスの
getInboxThreads メソッドを使用する。
  
  
【構文】
GmailApp.getInboxThreads()
GmailApp.getInboxThreads(startindex, numthreads)
  
startindex : int 型。取得したい最初のスレッドのインデックス番号を指定する。
numthreads : int 型。スレッド数を指定する。
戻り値 : GmailThread (配列) 型。取得したいスレッドオブジェクトの配列を返す。
  
・受信トレイにある全てのスレッドを取得したい場合は、引数を指定しない。
・スレッドのインデックス番号はゼロから始まる。従って、三件目のスレッドを取得する場合
  は第一引数に「2」を指定する。
・受信トレイにあるスレッド数より startindex の値が大きい場合は戻り値の配列の要素数
  はゼロとなる。
startindex で指定された以降のスレッドが numthreads の値よりも小さい場合は、
  存在するスレッドだけが返される。例えば、startindex に「2」、numthreads に「5」を
  指定した場合で、インデックス番号「2」、すなわち、三件目以降のスレッドが二件しか
  存在しない場合は、その二件のスレッドが戻り値として返される。
  
  
【例】
function GetGmailThreads() {
  var objThreads;
  // 全てのスレッドを取得する
  objThreads = GmailApp.getInboxThreads();
  Browser.msgBox(objThreads.length);
  // 三件目のスレッド以前のスレッドを五件取得する
  objThreads = GmailApp.getInboxThreads(2, 5);
  Browser.msgBox(objThreads.length);
}
  
  
この例では、最初に表示されるメッセージボックスには受信トレイにある全てのスレッドの件数
が表示され、続いて表示されるメッセージボックスには「5」と表示される (第二引数に「5」と
指定した為)。

0 件のコメント:

コメントを投稿