コマンド一覧

現在メールの問い合わせ関係

• 現在メールの問い合わせ関係
  • MailType, NewMailType関数（TKInfo.dll)
    • 返り値（数値型）
    • 例
  • CurrentHeader, CurrentHeader2, CountCurrentHeader関数（TKInfo.dll）
    • パラメータ１（文字列型）
    • パラメータ２（数値型、CurrentHeader2関数のみ）
    • 返り値（文字列型） CurrentHeader, CurrentHeader2
    • 返り値（数値型） CountCurrentHeader
    • 例
  • IsUnread関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • IsMarked関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • IsOrikaeshi関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • HeaderView関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • IsHighPriority関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • IsRequestNotification関数（TKInfo.dll）
    • 返り値（数値型）
    • 例
  • MailFileName, MailFilePath, MailFileOffset関数（TKInfo.dll）
    • 返り値（MailFileName, MailFilePath関数、文字列型）
    • 返り値（MailFileOffset関数、数値型）
    • 例
  • XMailer関数（TKInfo.dll）
    • 返り値（文字列型）
    • 例

---

MailType, NewMailType関数（TKInfo.dll)

　MailType関数は、秀丸メール本体ウィンドウまたはメールエディタが現在表示しているメールの種類を返します。パラメータはありません。
　NewMailType関数は、新規作成されたメールエディタ・ウィンドウ上で、そのメールエディタがどういう理由で起動されたのかを表します。例えば「mailto:」プロトコルによって起動されたのかどうか等を取得することが出来ます。

返り値（数値型）

MailType関数の返す値は以下の通りです。

　-1 ... 何も無い場合（秀丸メール本体側で、何もメールが選択されてない場合）
　０ ... 新規作成のメール（まだ保存されてない段階の物）
　１ ... 返信メール（まだ保存されてない段階の物）
　２ ... 転送メール（まだ保存されてない段階の物）
　３ ... 受信したメールの場合
　４ ... 送信済みメールの場合
　５ ... 未送信フォルダまたは草稿フォルダに保存された未送信メール
　６ ... 「添付ファイルとして転送」で作成されたメールで、まだ保存されてない段階の物。

NewMailType関数の返す値は以下の通りです。

　0 ... 新規作成のメールじゃない
　1 ... 普通に新規作成されたメールなど（2, 3以外の物すべて）
　2 ... 「mailto:XXXXX」のような形で起動されたメール
　3 ... アドレス帳から起動されたメール

例

#n = dllfunc( "MailType" );
if( #n == 0 ) message "新規メールです。";
if( dllfunc("NewMailType") == 2 ) {
  message "mailto:で起動されました。";
}

---

CurrentHeader, CurrentHeader2, CountCurrentHeader関数（TKInfo.dll）

　CurrentHeader関数は、現在のメールのヘッダ部分から任意のヘッダを検索して、その値部分を返します。編集途中であっても、その編集途中のヘッダ部分の値を返します。
　CurrentHeader2関数は、同じヘッダが複数ある場合に、追加パラメータで指定された位置のヘッダ内容を返します。CurrentHeader関数は先頭のヘッダの値のみを返します。
　CountCurrentHeaderは、パラメータ１で指定されたヘッダがメール中にいくつあるかを返します。まったく無い場合は０、１つある場合は１、…となります。

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

　検索したいヘッダです。"Subject"のように、名前のみを指定します。ヘッダ名の大文字/小文字は区別されません。

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

　同じヘッダが複数ある場合用に、ヘッダの番号を指定します。0を指定すると先頭、1を指定するとその次…です。

返り値（文字列型） CurrentHeader, CurrentHeader2

　見つかったヘッダの内容部分です。ヘッダが見つからない場合または内容が空っぽの場合は""を返します。

返り値（数値型） CountCurrentHeader

　見つかったヘッダの個数を返します。

例

$ReplyTo = dllfuncstr( "CurrentHeader", "Reply-To" );
$Attach = dllfuncstr("CurrentHeader2", "X-Attach", 0 );
#n = dllfunc("CountCurrentHeader", "X-Attach");

---

IsUnread関数（TKInfo.dll）

　この関数は、現在のメールが未読かどうかを返します。メールが複数選択されている場合には点線のフォーカス枠のついているメールについて未読かどうか返します。

返り値（数値型）

　未読の場合は1、既読の場合は0を返します。

例

#unread = dllfunc( "IsUnread" );

---

IsMarked関数（TKInfo.dll）

　この関数は、現在のメールがマークされているかどうかを返します。メールが複数選択されている場合には点線のフォーカス枠のついているメールについての状態を返します。

返り値（数値型）

　マークされている場合は１、そうでない場合は０を返します。

例

#marked = dllfunc( "IsMarked" );

---

IsOrikaeshi関数（TKInfo.dll）

　この関数は、現在のメールが「自動折り返し」になっているかどうかを返します。メールが複数選択されている場合には点線のフォーカス枠のついているメールについての状態を返します。

返り値（数値型）

　折り返しONの場合は１、そうでない場合は０を返します。普通は折り返しONです。

例

#orikaeshi = dllfunc( "IsOrikaeshi" );

---

HeaderView関数（TKInfo.dll）

　HeaderView関数は、現在のヘッダ表示のモードを返します。

返り値（数値型）

　「表示しない」の場合は0、簡略表示の場合は1、全体表示の場合は2を返します。

例

if( dllfunc("HeaderView") == 2 ) #n = dllfunc("SwitchHeaderView", 1);

---

IsHighPriority関数（TKInfo.dll）

　この関数は、現在のメールが「優先度:高」になっているかどうかを返します。メールが複数選択されている場合には点線のフォーカス枠のついているメールについての状態を返します。

返り値（数値型）

　「優先度:高」の場合は１、そうでないときは０を返します。編集中のメールの場合は「設定・優先度:高」のチェック状態を返し、そうでないときはメール中の「Priority:」ヘッダ等の値を参照します。

例

#HighPriority = dllfunc( "IsHighPriority" );

---

IsRequestNotification関数（TKInfo.dll）

　この関数は、現在のエディタの「設定・開封通知を要求する」の状態を返します。

返り値（数値型）

　「開封通知を要求する」がONの場合は１、そうでないときは０を返します。秀丸メール本体ウィンドウ上で実行した場合や、または編集中でない状態の時（開封通知を要求するメニューが灰色表示の時）は０を返します。

例

#RequestNotification = dllfunc( "IsRequestNotification" );

---

MailFileName, MailFilePath, MailFileOffset関数（TKInfo.dll）

　MailFileName関数は、現在表示しているメールの保存されているファイル名を返します。MailFilePath関数は、ファイルのフルパスを返します。

　MailFileOffset関数は、現在のメールがファイル中でどの位置にあるかの情報（ファイル先頭からのバイト数）を返します。ここで返す位置には、「Ctrl-L! 」という形式の秀丸メールのメール区切り記号が入っています。メール本体は１行下からになります。

　これらの関数は秀丸メール本体上でもメールエディタ上でも使えます。

返り値（MailFileName, MailFilePath関数、文字列型）

　ファイル名またはファイルのパス名です。まだ保存されていない場合や何も表示していない場合は""を返します。

返り値（MailFileOffset関数、数値型）

　ファイルのオフセットを返します。まだ保存されていない場合や何も表示していない場合は-1を返します。

例

message dllfuncstr("MailFileName");
message dllfuncstr("MailFilePath");
message str( dllfunc("MailFileOffset") );

---

XMailer関数（TKInfo.dll）

　XMailer関数は、秀丸メールが標準で送る「X-Mailer:」ヘッダの内容を返します。この文字列には秀丸メールを表す「HidemaruMail」という文字列の他、秀丸メールのバージョン番号とWindowsの種類についての情報が含まれます。ただし、「全般的な設定・上級者向け・送信時のエンコード」の「X-MailerヘッダにWindowsのバージョン番号を入れる」がOFFだとWindowsの種類についての情報が省略されるます。

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

返り値（文字列型）

　「X-Mailer:」ヘッダの内容文字列です。

例

#n = dllfunc("SetHeader", "X-Mailer", dllfuncstr("XMailer"));

---