コマンド一覧

メール閲覧関係

• メール閲覧関係
  • NextUnread, PrevUnread関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • NextMail, PrevMail関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • NextUnreadPage, PrevUnreadPage関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • NextPage2関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • NextUnreadCustom, PrevUnreadCustom関数（TKInfo.dll）
    • パラメータ１（文字列型）
    • 返り値（数値型）
    • 例
  • NextPrevCustom関数（TKInfo.dll）
    • パラメータ１（文字列型）
    • パラメータ２（文字列型）
    • パラメータ３（文字列型）
    • パラメータ４（文字列型）
    • パラメータ５（数値型）
    • パラメータ１に"findflag"を指定した場合の動作について
    • 返り値（数値型）
    • 例
  • IsGrepWndBrowseMode関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
    • 備考

---

NextUnread, PrevUnread関数（TKInfo.dll）

　NextUnread関数は、「下の未読メール」コマンドを実行します。エディタ・ウィンドウ中でも実行できます。PrevUnread関数は「上の未読メール」コマンドを実行します。
　秀丸メール本体ウィンドウで実行する場合で、全般的な設定によってはフォルダをまたがって未読メールを表示する場合もあります。

　「全般的な設定・メール一覧・閲覧関係」の設定によって進行方向が変わってしまうことがあるので、確実に上方向／下方向に移動させたい場合はNextPrevCustom関数を使ってください。

返り値（数値型）

　返り値に意味はありません（下の未読メールが無い場合でもエラーになりません）。

例

#n = dllfunc( "NextUnread" );
#n = dllfunc( "PrevUnread" );

---

NextMail, PrevMail関数（TKInfo.dll）

　NextMail関数は、「下のメール」コマンドを実行します。エディタ・ウィンドウ中でも実行できます。PrevMail関数は「上のメール」コマンドを実行します。
　「全般的な設定・メール一覧・閲覧関係」の設定によって進行方向が変わってしまうことがあるので、確実に上方向／下方向に移動させたい場合はNextPrevCustom関数を使ってください。

返り値（数値型）

　返り値に意味はありません（下のメールが無い場合でもエラーになりません）。

例

#n = dllfunc( "NextMail" );

---

NextUnreadPage, PrevUnreadPage関数（TKInfo.dll）

　NextUnreadPage関数は、「下の未読ページ」コマンドを実行します。エディタ・ウィンドウ中でも実行できます。PrevUnreadPage関数は「上の未読ページ」コマンドを実行します。
　秀丸メール本体ウィンドウで実行する場合で、全般的な設定によってはフォルダをまたがって未読メールを表示する場合もあります。

　「全般的な設定・閲覧関係」の設定によって進行方向が変わってしまうことがあるので、確実に上方向／下方向に移動させたい場合はNextPrevCustom関数を使ってください。

返り値（数値型）

　返り値に意味はありません（下の未読メールが無い場合でもエラーになりません）。

例

#n = dllfunc( "NextUnreadPage" );
#n = dllfunc( "PrevUnreadPage" );

---

NextPage2関数（TKInfo.dll）

　NextPage2関数は、秀丸エディタのnextpageと同様に、「次のページ」コマンドを実行します。ただし、こちらの関数の場合は、１行しかスクロールできない場合でも確実に１ページ分スクロールさせます。
　または、もし画面にメール末尾まで表示されていた場合には、スクロールせずに0を返します。

返り値（数値型）

　スクロールした場合は１、スクロールしなかった場合は０を返します。

例

#n = dllfunc( "NextPage2" );

---

NextUnreadCustom, PrevUnreadCustom関数（TKInfo.dll）

　NextUnreadCustom関数は、秀丸メール側の「全般的な設定・メール一覧・閲覧関係」で「下の未読メール等で、下に未読が無かった場合」のオプションを一時的に変更して「下の未読メール」コマンドを実行します。
　PrevUnreadCustom関数は、同様に、設定を一時的に変更して「上の未読メール」コマンドを実行します。

　実行し終わると設定は元に戻ります。

　「全般的な設定・メール一覧・閲覧関係」の設定によって進行方向が変わってしまうことがあるので、確実に上方向／下方向に移動させたい場合はNextPrevCustom関数を使ってください。

パラメータ１（文字列型）

　オプションを指定します。

""	何もしない
"Roll"	フォルダ内を一周する
"Over"	フォルダをまたがる
"Query"	進行方向の問い合わせメッセージを出す
"Super"	未読があればフォルダ内を一周、無ければフォルダをまたがる

返り値（数値型）

　返り値に意味はありません（下の未読メールが無い場合でもエラーになりません）。

例

#n = dllfunc( "NextUnreadCustom", "");

---

NextPrevCustom関数（TKInfo.dll）

　NextPrevCustom関数は、秀丸メールの閲覧関係の設定に関係なく、細かいオプション指定で「次のメール／次の未読メール／次の未読ページ／次のマーク」系および「前の××」系コマンドを実行します。

パラメータ１（文字列型）

　次のメール（または前のメール、または上のメールまたは下のメール）の対象を指定します。ここのパラメータも含めて、文字列形式のパラメータは大文字でも小文字でもかまいません。

""	進行方向の一番近いメール
"Neighbor"	""と同じ
"Unread"	未読メール
"Mark"	マークしたメール
"findflag"	SetFindPack関数でflag=で指定した条件にマッチするメール（詳細は後述）

パラメータ２（文字列型）

　進行方向を指定します。

"down"	下方向
"up"	上方向
"next"	メール一覧のソート方法が逆順（▲）の場合は上方向、そうでない場合は下方向。ただし、フォルダをまたがる場合のフォルダの方向は下。
"prev"	メール一覧のソート方法が逆順（▲）の場合は下方向、そうでない場合は上方向。ただし、フォルダをまたがる場合のフォルダの方向は上。

パラメータ３（文字列型）

　ページ単位で移動するか、またはメール単位かを指定します。

""	メール単位
"Mail"	メール単位
"Page"	ページ単位。進行方向が"down"または"next"なら次ページ、そうでなければ前ページ。

パラメータ４（文字列型）

　フォルダのまたがり方についてのオプションを指定します。

""	何もしない（フォルダをまたがらない）
"Roll"	フォルダ内を一周する
"Over"	フォルダをまたがる
"Query"	進行方向の問い合わせメッセージを出す
"Super"	未読があればフォルダ内を一周、無ければフォルダをまたがる。ただし、一周できない場合は常にフォルダをまたがる。
"RollAccount"	フォルダをまたがりつつ、アカウント内を一周する
"RollAll"	フォルダをまたがりつつ、全アカウントを一周する
"RollFolderAccount"	フォルダ内を一周しつつ、アカウント内を一周する
"RollFolderAll"	フォルダ内を一周しつつ、全アカウントを一周する

パラメータ５（数値型）

　パラメータ1に"findflag"を指定してる場合でフォルダをまたがって検索する時に、ゴミ箱フォルダを対象外にするかどうか指定します。0を指定するとゴミ箱フォルダも含めて検索し、1を指定するとゴミ箱フォルダを除外します。
　パラメータ５を省略すると、0が指定されたことと見なされます。

パラメータ１に"findflag"を指定した場合の動作について

　パラメータ１に"findflag"を指定した場合、SetFindPack関数でセットされる検索条件のフラグ指定にマッチするメールを探す動作となります。具体的には、SetFindPack関数で"flag=XXXX"のような指定をして、それにマッチするメールを探すことになります。

　"findflag"を指定する場合は、直前にSetFindPack関数を呼び出して、検索したいメールのフラグを指定してください。flag=以外の指定については無視されます。

　　例：

	#n = dllfunc("SetFindPack", "flag=mark");
	#n = dllfunc("NextPrevCustom", "findflag", "down", "", "Over", 1);

返り値（数値型）

　何らかのメールを選択できた場合は1、失敗した場合は0を返します（NextUnreadCustom等と違って、値を返します）。
　また、V2.20より、同一メール内でページが進んだだけの場合に1を返すように修正しました（V2.19以下ではページが進んだだけの場合に0を返します）。

例

#n = dllfunc( "NextPrevCustom", "unread", "next", "mail", "over");

---

IsGrepWndBrowseMode関数（TKInfo.dll）

　IsGrepWndBrowseMode関数は、現在のエディタ上での「下の未読メール」などのコマンドが検索結果ウィンドウ上で動作するかどうかを返します。

　「検索して一覧作成」によって検索し、そこの一覧からエディタを起動した場合、エディタ上での「下のメール」などのコマンドは、検索結果の一覧上で動作します。このIsGrepWndBrowseMode関数は、そのモードなのかどうかを返します。

　検索結果の一覧上で動作するコマンドは以下の通りです。

　上のメール／下のメール、上の未読メール／下の未読メール、
　上のページ／下のページ、上の未読ページ、下の未読ページ、

　NextPrevCustom関数。

返り値（数値型）

　検索結果の一覧上で動作するモードの時は１、そうでないときは０を返します。

例

if( dllfunc( "IsGrepWndBrowseMode") ) {
    message "検索結果上では使えません。";
}

備考

　検索結果上で動作するモードから抜け出すには、検索結果ウィンドウよりも秀丸メール本体ウィンドウを手前に移動すればいいです。たとえばSetMainWndTop関数を実行してからエディタに戻るなどすればいいです。

---