コマンド一覧

メールごとのコマンド

• メールごとのコマンド
  • SwitchMark関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • SwitchUnread関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • SwitchOrikaeshi関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • SwitchHeaderView関数（TKInfo.dll）
    • パラメータ１（数値型）
    • 返り値（数値型）
    • 例
  • SetHighPriority関数（TKInfo.dll）
    • パラメータ１（数値型、文字列型どちらでもOK）
    • 返り値（数値型）
    • 例
  • SetRequestNotification関数（TKInfo.dll）
    • パラメータ１（数値型、文字列型どちらでもOK）
    • 返り値（数値型）
    • 例
  • GetMailFlag/SetMailFlag関数（TKInfo.dll）
    • パラメータ１（文字列型）
    • パラメータ２（SetMailFlagのみ、数値型）
    • 返り値（数値型）
    • 例（現在のメールを新着にする例）
  • GetMailColor/SetMailColor関数（TKInfo.dll）
    • パラメータ１（数値型、SetMailColorのみ）
    • 返り値（数値型）
    • 例（現在のメールを赤色にする例）
  • GetMailSize関数（TKInfo.dll）
    • パラメータ１（数値型）
    • 返り値（数値型）
    • 例
  • GetMailTransmitDate/SetMailTransmitDate関数（TKInfo.dll）
    • パラメータ１（文字列型、SetMailTransmitDateのみ）
    • 返り値
    • 例
  • SetCharSet関数（TKInfo.dll）
    • パラメータ１（文字列）
    • パラメータ２（数値型）
    • 返り値（数値型）
    • 例

---

SwitchMark関数（TKInfo.dll）

　この関数は、現在のメールのマークを設定/解除します。マークの設定/解除コマンド自体は秀丸メール本体ウィンドウ上にしかありませんが、この関数はメールエディタ・ウィンドウ中でも実行可能です。

返り値（数値型）

　返り値に意味はありません。

例

#n = dllfunc( "SwitchMark" );

---

SwitchUnread関数（TKInfo.dll）

　この関数は、現在のメールの未読/既読を切り替えます。未読/既読の切り替えコマンド自体は秀丸メール本体ウィンドウ上にしかありませんが、この関数はメールエディタ・ウィンドウ中でも実行可能です。

返り値（数値型）

　返り値に意味はありません。

例

#n = dllfunc( "SwitchUnread" );

---

SwitchOrikaeshi関数（TKInfo.dll）

　この関数は、現在のメールの「自動折り返し」の設定のON/OFF切り替えをします。

返り値（数値型）

　返り値に意味はありません。

例

#n = dllfunc( "SwitchOrikaeshi" );

---

SwitchHeaderView関数（TKInfo.dll）

　SwitchHeaderViewは、ヘッダ表示のモードをパラメータにしたがって切り替えます。

パラメータ１（数値型）

　ヘッダ表示の状態を指定します。0の場合は表示しない、1の場合は簡略表示、2の場合は全体表示、3の場合は「切り替え」コマンドの実行です。

返り値（数値型）

　返り値に意味はありません。

例

#n = dllfunc("SwitchHeaderView", 2);	// 全体表示

---

SetHighPriority関数（TKInfo.dll）

　この関数は、現在のエディタのメニュー上の「優先度:高」のチェック状態を切り換えます。メニューが灰色になっている時は何もせずにエラーを返します。また、エディタ上でしか使えません。

パラメータ１（数値型、文字列型どちらでもOK）

　０を渡すとOFF、１を渡すとONとなります。"0"または"1"と指定することもできます（テンプレートからも呼び出せるようにするため）。

返り値（数値型）

　成功すると1、失敗すると０を返します。

例

#n = dllfunc( "SetHighPriority", 1 );

---

SetRequestNotification関数（TKInfo.dll）

　この関数は、現在のメールエディタのメニュー上の「開封通知を要求する」のチェック状態を切り換えます。メールエディタ上で、メニューが選択できる状態の時しか使えません。

パラメータ１（数値型、文字列型どちらでもOK）

　０を渡すとOFF、１を渡すとONとなります。"0"または"1"と指定することもできます（テンプレートからも呼び出せるようにするため）。

返り値（数値型）

　成功すると1、失敗すると０を返します。

例

#n = dllfunc( "SetRequestNotification", 1 );

---

GetMailFlag/SetMailFlag関数（TKInfo.dll）

　GetMailFlagは、メール毎に存在する各種のフラグの値を取得します。SetMailFlagはそれらのフラグの値を書き換えます。

　この関数は秀丸メール本体上でもメールエディタ上でも実行できます。

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

　フラグの種類を指定します。フラグの種類には以下の名前が指定できます。
　

attach	添付ファイル付きかどうか
send	送信系メールかどうか
messageid	Message-IDを含んだメールかどうか
inreplyid	「In-Reply-To:」または「References:」付きのメールかどうか
mark	マークされているかどうか
cc	複数宛先メールかどうか
encoded	エンコードされた形かどうか（受信ログ/送信ログかどうか）
priority1	「優先度=高」かどうか
orikaeshi	自動折り返しがONかどうか
sent	送信済みメールかどうか（送信系の場合のみ）
html	HTMLメールかどうか（受信系の場合のみ）
reply	受信系の場合、返信済みかどうか
forward	受信系の場合、転送済みかどうか
unread	未読かどうか
altered	改変されたかどうか
hot	新着メールかどうか
memo	メモ付きかどうか

パラメータ２（SetMailFlagのみ、数値型）

　フラグをセットする場合は１、リセットする場合は０を指定します。SetMailFlagできるフラグは、send, mark, orikaeshi, sent, reply, forward, unread, altered, hotのみで、他のフラグは書き換えできません。

返り値（数値型）

　GetMailFlag関数は、フラグがセットされていると1、セットされてないと０を返します。たとえば"unread"は、未読の場合は１、既読の場合は０を返します。

　SetMailFlag関数は、フラグの書き換えに成功すると１、失敗すると０を返します。

例（現在のメールを新着にする例）

#n = dllfunc("GetMailFlag", "hot");
if( #n == 0 ) #n = dllfunc("SetMailFlag", "hot", 1);

---

GetMailColor/SetMailColor関数（TKInfo.dll）

　GetMailColorは、メールのメール一覧上での色を返します。SetMailColorはメールの色を書き換えます。

　この関数は秀丸メール本体上でもメールエディタ上でも実行できます。

パラメータ１（数値型、SetMailColorのみ）

　色を番号で指定します。番号は０〜１５まで指定できます。０を指定すると「色なし」、１だと「赤」のようになります。番号と色の対応は、メールのプロパティダイアログボックスでの色の並び順と同じです。

返り値（数値型）

　GetMailColor関数は、メールの色を返します。

　SetMailFlag関数は、色の書き換えに成功すると１、失敗すると０を返します。

例（現在のメールを赤色にする例）

#n = dllfunc("GetMailColor");
if( #n != 1 ) #n = dllfunc("SetMailColor", 1);

---

GetMailSize関数（TKInfo.dll）

　GetMailSizeは、メールのサイズを取得します。

　この関数は秀丸メール本体上でもメールエディタ上でも実行できます。

パラメータ１（数値型）

　０を指定するか、またはパラメータを省略すると、添付ファイルも含んだメールの総バイト数を返します。
　０以外を指定すると、添付ファイルを含まないメールのサイズを返します。

返り値（数値型）

　メールのサイズをバイト数で返します。
　エラーの場合（たとえば何もメールを選択してない場合）は、0を返します。

例

#n = dllfunc("GetMailSize");

---

GetMailTransmitDate/SetMailTransmitDate関数（TKInfo.dll）

　GetMailTransmitDateは、メールの送受信日付/時刻を返します。返す値は文字列型で、「メールのプロパティ」ダイアログボックス上で表示されるのと同じ形式の文字列を返します。

　SetMailTransmitDate関数は、メールの送受信日付/時刻を書き換えます。こちらでの文字列の指定方法も、「メールのプロパティ」ダイアログボックスと同じでないといけません。

パラメータ１（文字列型、SetMailTransmitDateのみ）

　日付/時刻の文字列を指定します。形式は、例えば2004年1月2日、3時45分12.345秒なら、"2004/01/02 03:45:12.345"のようになります。

返り値

　GetMailTransmitDate関数は、メールの送受信日付/時刻を文字列形式で返します。何らかのエラーが起きた場合は""を返します。
　SetMailTransmitDate関数は、書き換えに成功すると１、失敗すると０を数値型で返します。

　新規作成したメールなどの、まだ保存されてないメール上ではうまく動作しません。

例

$s = dllfuncstr("GetMailTransmitDate");
message $s;
#n = dllfunc("SetMailTransmitDate", leftstr($s, 11) + "00:00:00.000");

---

SetCharSet関数（TKInfo.dll）

　SetCharSet関数は、メールの文字コードを設定します。この関数は、エディタ上の「設定・文字コード」メニュー中のコマンドを実行するのとまったく同じ動作です。成功するとメール中の「Content-Type:」ヘッダが書き換えられます。

パラメータ１（文字列）

　文字コードを指定します。以下の文字列が指定できます。

""または"iso-2022-jp"または"japan"	日本語
"euro"または"windows-1252"	欧文
"gb2312"	簡体字中国語
"big5"	繁体字中国語
"korea"または"ks_c_5601"	韓国語
"russian"または"windows-1251"	ロシア語
"centraleuro"または"windows-1250"	中央ヨーロッパ言語
"thai"または"tis-620"	タイ語
"utf-8"	多国語混在ユニコード

パラメータ２（数値型）

　変換できない文字があった場合の処理方法を指定します。
　0を指定するか、またはパラメータ２自体を省略した場合には、処理方法についての問い合わせメッセージが出てきます。
　1を指定した場合には、「テキストの内容を維持したまま変換する」となり、この場合は変換できなかった文字が「?」のようになります。
　2を指定した場合には、「バイナリを維持したまま文字コードを適用する」という動作になります。

返り値（数値型）

　成功すると１、失敗すると０を返します。

例

#n = dllfunc("SetCharSet", "euro", 1);

---