秀丸メールマクロヘルプ8
コマンド一覧
この関数は、現在の秀丸メールに登録されているアカウントの名前を返します。パラメータとしてアカウントの番号を指定します。この関数は秀丸メール本体側でのみ使えます。
アカウントの番号です。アカウントの番号は、フォルダ枠上でのアカウントの並んでいる番号で、先頭のアカウントは０です。
アカウント名です。該当するアカウントが無い場合（例えば、２つ登録してある場合に２番を指定した場合）には""を返します。
CurrentAccount関数は、フォルダ枠中で、現在選択されているアカウント（または現在選択されているフォルダを含むアカウント）のアカウント名を返します。または、エディタ上で実行した場合には、現在のエディタが開いているメールのアカウントを返します。
CurrentAccountGroup関数は、同じく、フォルダ枠中では、現在何らかのアカウントグループが選択されていればそのアカウントグループ名を返し、その他が選択されてる場合は、現在選択されているアカウント（または現在選択されているフォルダを含むアカウント）の属するアカウントグループ名を返します。エディタ上で実行した場合には、現在のエディタが開いているメールのアカウントについてのアカウントグループ名を返します。
どこのアカウントグループにも属してない場合は""を返します。
CurrentAccount関数はアカウント名文字列を返します。
CurrentAccountGroup関数は、アカウントグループ名を返します。アカウントグループに属してない場合は""を返します。
この関数は、フォルダ枠中で現在選択しているフォルダの名前を返します。または、エディタ上で実行した場合には、現在のエディタが開いているメールのフォルダを返します。
現在選択しているフォルダの名前です。具体的には、"受信"、"未送信"などの表示されている名前をそのまま返します。
受信フォルダ、送信済みフォルダ、草稿フォルダ配下に作成したフォルダ（ユーザーが作成したフォルダ）を選択している場合には、そのフォルダのパスを「\」区切りで返します。例えば、「受信\テスト」のように返します。
フォルダではなくアカウントを選択している場合は""を返します。
注意事項
アカウント直下にユーザーが作成されたフォルダは、秀丸メール内部では、アカウント直下ではなく、アカウント直下の「User」というフォルダの配下に存在しているような扱いとなっています。マクロ上でもそれがそのまま適用されます。
例えばアカウント直下に「ABC」というフォルダがある場合、CurrentFolder関数の返す値は「User\ABC」となります。他、フォルダを扱う関数では、すべて「User」が間に入ってくることにご注意ください。
この関数は、フォルダ枠の中で、特定のフォルダまたはアカウントを選択します。パラメータは２つあり、１つ目がアカウント名、２つ目がフォルダ名です。
選択したいフォルダを含むアカウント名です。""を指定すると現在のアカウントという意味になります。
選択したいフォルダ名です。例えば受信フォルダの場合は「受信」です。ユーザーが作成したフォルダの場合は、例えば「受信\テスト」のように指定します。マクロの中で固定の文字列で指定する場合は、"受信\\テスト"のように指定します。
アカウントそのものを選択したい場合には、""を指定します。
選択に成功すると１、失敗すると０を返します。
アカウント直下にユーザーが作成されたフォルダは、秀丸メール内部では、アカウント直下ではなく、アカウント直下の「User」というフォルダの配下に存在しているような扱いとなっています。マクロ上でもそれがそのまま適用されます。
この関数は、現在選択しているフォルダまたはアカウントの折りたたみ/展開状態を切り替えます。
アカウントを選択している状態でExpandFolderを使って展開した場合、自動的に「受信」フォルダが選択されます。
展開する場合は１、折りたたむ場合は０を指定します。
返り値に意味はありません。
NextFolder関数は、「下のフォルダ」コマンドを実行します。このコマンドは現在選択しているフォルダより１つ下のフォルダを選択するコマンドです。PrevFolder関数は「上のフォルダ」を選択します。
フォルダを選択せずに、上下方向のフォルダの名前だけが知りたい場合には、GetNextFolder/GetPrevFolder関数を使います。
成功すると１を返します。上または下にこれ以上フォルダがない場合は０を返します。
GetNextFolder関数は、パラメータで指定されたフォルダの下にあるフォルダの名前を返します。GetPrevFolder関数は、上にあるフォルダの名前を返します。
対象のメール用のフォルダを含むアカウント名です。""を指定すると現在選択しているアカウントになります。
対象のフォルダ名です。例えば受信フォルダの場合は「受信」です。ユーザーが作成したフォルダの場合は、例えば「受信\テスト」のように指定します。マクロの中で固定の文字列で指定する場合は、"受信\\テスト"のように指定します。
パラメータ１とパラメータ２の両方に""を指定するか、またはパラメータ１、パラメータ２両方ともを省略すると、現在選択しているフォルダという意味になります。
指定された方向のフォルダの「アカウント名」と「フォルダ名」を「\」記号で区切った文字列を返します。例えば「テストアカウント」というアカウントの「受信」フォルダの場合は、「テストアカウント\受信」という文字列を返します。
アカウントそのものの場合は、フォルダ名無しでアカウント名のみを返します。
指定された方向にフォルダが無い場合には、""を返します。
折りたたまれたフォルダ／アカウントは展開されているつもりで動作します。例えばパラメータで指定されたフォルダが折りたたまれている時に、GetNextFolder関数の返す値は折りたたまれた中の先頭のフォルダです。
返り値からアカウント名とフォルダ名を分離する方法は、以下の例を参照ください。
この関数は、パラメータで指定されたフォルダの配下にさらにフォルダがあるかどうか、ある場合はそれが折り畳まれているか、それとも展開されているかを返します。
対象のメール用のフォルダを含むアカウント名です。""を指定すると現在選択しているアカウントになります。
対象のメール用のフォルダ名です。例えば受信フォルダの場合は「受信」です。ユーザーが作成したフォルダの場合は、例えば「受信\テスト」のように指定します。マクロの中で固定の文字列で指定する場合は、"受信\\テスト"のように指定します。
パラメータ１とパラメータ２の両方に""を指定するか、またはパラメータ１、パラメータ２両方ともを省略すると、現在選択しているフォルダという意味になります。
現在選択されているフォルダ（アカウントの場合も含む）の配下に子となるフォルダがある場合で、
折り畳まれている場合、0
展開されている場合、1
を返します。
配下に子となるフォルダ類が無い場合は2を返します。
パラメータで指定されたフォルダ（またはアカウント自体）が存在しない場合は、-1を返します。
アカウント直下にユーザーが作成されたフォルダは、秀丸メール内部では、アカウント直下ではなく、アカウント直下の「User」というフォルダの配下に存在しているような扱いとなっています。マクロ上でもそれがそのまま適用されます。
例えばアカウント直下に「ABC」というフォルダがある場合、CurrentFolder関数の返す値は「User\ABC」となります。他、フォルダを扱う関数では、すべて「User」が間に入ってくることにご注意ください。
この関数は、パラメータで指定されたフォルダが未読フォルダ状態になっているかどうかを返します。「未読フォルダ」というのは、例えば何かメールを受信してフォルダに振り分けられた時に、フォルダ用のアイコンが水色に変わった状態のことを言います。フォルダを選択して１秒程度放置すると未読フォルダ状態が解除されます。「全般的な設定・フォルダ」の「未読のフォルダを水色表示する」がONになっている場合にのみ発生します。
対象のメール用のフォルダを含むアカウント名です。""を指定すると現在選択しているアカウントになります。
対象のフォルダ名です。例えば受信フォルダの場合は「受信」です。ユーザーが作成したフォルダの場合は、例えば「受信\テスト」のように指定します。マクロの中で固定の文字列で指定する場合は、"受信\\テスト"のように指定します。
パラメータ１とパラメータ２の両方に""を指定するか、またはパラメータ１、パラメータ２両方ともを省略すると、現在選択しているフォルダという意味になります。
未読フォルダになっている場合は１、そうでない場合は０を返します。
この関数は、パラメータで指定されたフォルダのメール数を返します。
対象のメール用のフォルダを含むアカウント名です。""を指定すると現在選択しているアカウントになります。
対象のフォルダ名です。例えば受信フォルダの場合は「受信」です。ユーザーが作成したフォルダの場合は、例えば「受信\テスト」のように指定します。マクロの中で固定の文字列で指定する場合は、"受信\\テスト"のように指定します。
パラメータ１とパラメータ２の両方に""を指定するか、またはパラメータ１、パラメータ２両方ともを省略すると、現在選択しているフォルダという意味になります。
対象フォルダ中のカウントするメールの対象を指定します。以下のパラメータが指定できます。
パラメータ３を省略した場合は"all"と解釈されます。
メール数を返します。
この関数は、パラメータで指定されたアカウントグループそのものを選択します。
選択したいアカウントグループ名です。
選択に成功すると１、失敗すると０を返します。
フォルダ関係（秀丸メール本体ウィンドウでのみ実行可能な物が多い）
- フォルダ関係（秀丸メール本体ウィンドウでのみ実行可能な物が多い）
- Account関数（TKInfo.dll）
- CurrentAccount, CurrentAccountGroup関数（TKInfo.dll）
- CurrentFolder関数（TKInfo.dll）
- SelectFolder関数（TKInfo.dll）
- ExpandFolder関数（TKInfo.dll）
- NextFolder, PrevFolder関数（TKInfo.dll）
- GetNextFolder, GetPrevFolder関数（TKInfo.dll）
- GetFolderExpandState関数（TKInfo.dll）
- GetFolderHotState関数（TKInfo.dll）
- GetFolderMailCount関数（TKInfo.dll）
- SelectAccountGroup関数（TKInfo.dll）
Account関数（TKInfo.dll）
この関数は、現在の秀丸メールに登録されているアカウントの名前を返します。パラメータとしてアカウントの番号を指定します。この関数は秀丸メール本体側でのみ使えます。
パラメータ１
アカウントの番号です。アカウントの番号は、フォルダ枠上でのアカウントの並んでいる番号で、先頭のアカウントは０です。
返り値（文字列型）
アカウント名です。該当するアカウントが無い場合（例えば、２つ登録してある場合に２番を指定した場合）には""を返します。
例
$TopAccount = dllfuncstr( "Account", 0 );
CurrentAccount, CurrentAccountGroup関数（TKInfo.dll）
CurrentAccount関数は、フォルダ枠中で、現在選択されているアカウント（または現在選択されているフォルダを含むアカウント）のアカウント名を返します。または、エディタ上で実行した場合には、現在のエディタが開いているメールのアカウントを返します。
CurrentAccountGroup関数は、同じく、フォルダ枠中では、現在何らかのアカウントグループが選択されていればそのアカウントグループ名を返し、その他が選択されてる場合は、現在選択されているアカウント（または現在選択されているフォルダを含むアカウント）の属するアカウントグループ名を返します。エディタ上で実行した場合には、現在のエディタが開いているメールのアカウントについてのアカウントグループ名を返します。
どこのアカウントグループにも属してない場合は""を返します。
返り値（文字列型）
CurrentAccount関数はアカウント名文字列を返します。
CurrentAccountGroup関数は、アカウントグループ名を返します。アカウントグループに属してない場合は""を返します。
例
$s = dllfuncstr( "CurrentAccount" ); $s = dllfuncstr( "CurrentAccountGroup" );
CurrentFolder関数（TKInfo.dll）
この関数は、フォルダ枠中で現在選択しているフォルダの名前を返します。または、エディタ上で実行した場合には、現在のエディタが開いているメールのフォルダを返します。
返り値（文字列型）
現在選択しているフォルダの名前です。具体的には、"受信"、"未送信"などの表示されている名前をそのまま返します。
受信フォルダ、送信済みフォルダ、草稿フォルダ配下に作成したフォルダ（ユーザーが作成したフォルダ）を選択している場合には、そのフォルダのパスを「\」区切りで返します。例えば、「受信\テスト」のように返します。
フォルダではなくアカウントを選択している場合は""を返します。
注意事項
アカウント直下にユーザーが作成されたフォルダは、秀丸メール内部では、アカウント直下ではなく、アカウント直下の「User」というフォルダの配下に存在しているような扱いとなっています。マクロ上でもそれがそのまま適用されます。
例えばアカウント直下に「ABC」というフォルダがある場合、CurrentFolder関数の返す値は「User\ABC」となります。他、フォルダを扱う関数では、すべて「User」が間に入ってくることにご注意ください。
例
$folder = dllfuncstr( "CurrentFolder" );
SelectFolder関数（TKInfo.dll）
この関数は、フォルダ枠の中で、特定のフォルダまたはアカウントを選択します。パラメータは２つあり、１つ目がアカウント名、２つ目がフォルダ名です。
パラメータ１（文字列型）
選択したいフォルダを含むアカウント名です。""を指定すると現在のアカウントという意味になります。
パラメータ２（文字列型）
選択したいフォルダ名です。例えば受信フォルダの場合は「受信」です。ユーザーが作成したフォルダの場合は、例えば「受信\テスト」のように指定します。マクロの中で固定の文字列で指定する場合は、"受信\\テスト"のように指定します。
アカウントそのものを選択したい場合には、""を指定します。
返り値（数値型）
選択に成功すると１、失敗すると０を返します。
注意事項
アカウント直下にユーザーが作成されたフォルダは、秀丸メール内部では、アカウント直下ではなく、アカウント直下の「User」というフォルダの配下に存在しているような扱いとなっています。マクロ上でもそれがそのまま適用されます。
例
#n = dllfunc( "SelectFolder", "テストアカウント", "受信" );
ExpandFolder関数（TKInfo.dll）
この関数は、現在選択しているフォルダまたはアカウントの折りたたみ/展開状態を切り替えます。
アカウントを選択している状態でExpandFolderを使って展開した場合、自動的に「受信」フォルダが選択されます。
パラメータ１（数値型）
展開する場合は１、折りたたむ場合は０を指定します。
返り値（数値型）
返り値に意味はありません。
例
#n = dllfunc( "ExpandFolder", 1 );
NextFolder, PrevFolder関数（TKInfo.dll）
NextFolder関数は、「下のフォルダ」コマンドを実行します。このコマンドは現在選択しているフォルダより１つ下のフォルダを選択するコマンドです。PrevFolder関数は「上のフォルダ」を選択します。
フォルダを選択せずに、上下方向のフォルダの名前だけが知りたい場合には、GetNextFolder/GetPrevFolder関数を使います。
返り値（数値型）
成功すると１を返します。上または下にこれ以上フォルダがない場合は０を返します。
例
#n = dllfunc("NextFolder");
GetNextFolder, GetPrevFolder関数（TKInfo.dll）
GetNextFolder関数は、パラメータで指定されたフォルダの下にあるフォルダの名前を返します。GetPrevFolder関数は、上にあるフォルダの名前を返します。
パラメータ１（文字列型）
対象のメール用のフォルダを含むアカウント名です。""を指定すると現在選択しているアカウントになります。
パラメータ２（文字列型）
対象のフォルダ名です。例えば受信フォルダの場合は「受信」です。ユーザーが作成したフォルダの場合は、例えば「受信\テスト」のように指定します。マクロの中で固定の文字列で指定する場合は、"受信\\テスト"のように指定します。
パラメータ１とパラメータ２の両方に""を指定するか、またはパラメータ１、パラメータ２両方ともを省略すると、現在選択しているフォルダという意味になります。
返り値（文字列型）
指定された方向のフォルダの「アカウント名」と「フォルダ名」を「\」記号で区切った文字列を返します。例えば「テストアカウント」というアカウントの「受信」フォルダの場合は、「テストアカウント\受信」という文字列を返します。
アカウントそのものの場合は、フォルダ名無しでアカウント名のみを返します。
指定された方向にフォルダが無い場合には、""を返します。
折りたたまれたフォルダ／アカウントは展開されているつもりで動作します。例えばパラメータで指定されたフォルダが折りたたまれている時に、GetNextFolder関数の返す値は折りたたまれた中の先頭のフォルダです。
返り値からアカウント名とフォルダ名を分離する方法は、以下の例を参照ください。
例
$s = dllfuncstr("GetNextFolder", "テストアカウント", "受信\\テスト");
#x = strstr( $s, "\\");
if( #x >= 0 ) {
$account = leftstr( $s, #x);
$folder = midstr( $s, #x + 1, 256 );
} else {
$account = $s;
$folder = "";
}
GetFolderExpandState関数（TKInfo.dll）
この関数は、パラメータで指定されたフォルダの配下にさらにフォルダがあるかどうか、ある場合はそれが折り畳まれているか、それとも展開されているかを返します。
パラメータ１（文字列型）
対象のメール用のフォルダを含むアカウント名です。""を指定すると現在選択しているアカウントになります。
パラメータ２（文字列型）
対象のメール用のフォルダ名です。例えば受信フォルダの場合は「受信」です。ユーザーが作成したフォルダの場合は、例えば「受信\テスト」のように指定します。マクロの中で固定の文字列で指定する場合は、"受信\\テスト"のように指定します。
パラメータ１とパラメータ２の両方に""を指定するか、またはパラメータ１、パラメータ２両方ともを省略すると、現在選択しているフォルダという意味になります。
返り値（数値型）
現在選択されているフォルダ（アカウントの場合も含む）の配下に子となるフォルダがある場合で、
折り畳まれている場合、0
展開されている場合、1
を返します。
配下に子となるフォルダ類が無い場合は2を返します。
パラメータで指定されたフォルダ（またはアカウント自体）が存在しない場合は、-1を返します。
注意事項
アカウント直下にユーザーが作成されたフォルダは、秀丸メール内部では、アカウント直下ではなく、アカウント直下の「User」というフォルダの配下に存在しているような扱いとなっています。マクロ上でもそれがそのまま適用されます。
例えばアカウント直下に「ABC」というフォルダがある場合、CurrentFolder関数の返す値は「User\ABC」となります。他、フォルダを扱う関数では、すべて「User」が間に入ってくることにご注意ください。
例
#n = dllfunc( "GetFolderExpandState"); #n = dllfunc( "GetFolderExpandState", "", "受信"); #n = dllfunc( "GetFolderExpandState", "テストアカウント", "受信\\テスト");
GetFolderHotState関数（TKInfo.dll）
この関数は、パラメータで指定されたフォルダが未読フォルダ状態になっているかどうかを返します。「未読フォルダ」というのは、例えば何かメールを受信してフォルダに振り分けられた時に、フォルダ用のアイコンが水色に変わった状態のことを言います。フォルダを選択して１秒程度放置すると未読フォルダ状態が解除されます。「全般的な設定・フォルダ」の「未読のフォルダを水色表示する」がONになっている場合にのみ発生します。
パラメータ１（文字列型）
対象のメール用のフォルダを含むアカウント名です。""を指定すると現在選択しているアカウントになります。
パラメータ２（文字列型）
対象のフォルダ名です。例えば受信フォルダの場合は「受信」です。ユーザーが作成したフォルダの場合は、例えば「受信\テスト」のように指定します。マクロの中で固定の文字列で指定する場合は、"受信\\テスト"のように指定します。
パラメータ１とパラメータ２の両方に""を指定するか、またはパラメータ１、パラメータ２両方ともを省略すると、現在選択しているフォルダという意味になります。
返り値（数値型）
未読フォルダになっている場合は１、そうでない場合は０を返します。
例
#n = dllfunc( "GetFolderHotState"); #n = dllfunc( "GetFolderHotState", "", "受信"); #n = dllfunc( "GetFolderHotState", "テストアカウント", "受信\\テスト");
GetFolderMailCount関数（TKInfo.dll）
この関数は、パラメータで指定されたフォルダのメール数を返します。
パラメータ１（文字列型）
対象のメール用のフォルダを含むアカウント名です。""を指定すると現在選択しているアカウントになります。
パラメータ２（文字列型）
対象のフォルダ名です。例えば受信フォルダの場合は「受信」です。ユーザーが作成したフォルダの場合は、例えば「受信\テスト」のように指定します。マクロの中で固定の文字列で指定する場合は、"受信\\テスト"のように指定します。
パラメータ１とパラメータ２の両方に""を指定するか、またはパラメータ１、パラメータ２両方ともを省略すると、現在選択しているフォルダという意味になります。
パラメータ３（文字列型）
対象フォルダ中のカウントするメールの対象を指定します。以下のパラメータが指定できます。
| "all" | すべて |
| "recent" | 最近の分 |
| "unread" | 未読分 |
| "mark" | マークされたメール |
| "priority1" | 優先度:高のメール |
| "hot" | 新着フラグがONになったメール |
パラメータ３を省略した場合は"all"と解釈されます。
返り値（数値型）
メール数を返します。
例
#n = dllfunc( "GetFolderMailCount"); #n = dllfunc( "GetFolderMailCount", "", "", "unread"); #n = dllfunc( "GetFolderMailCount", "テストアカウント", "受信\\テスト", "recent");
SelectAccountGroup関数（TKInfo.dll）
この関数は、パラメータで指定されたアカウントグループそのものを選択します。
パラメータ１（文字列型）
選択したいアカウントグループ名です。
返り値（数値型）
選択に成功すると１、失敗すると０を返します。
例
#n = dllfunc( "SelectAccountGroup", "テストグループ" );
2006年05月11日(木) 02:48:23 Modified by aqualung