## milter-test-server

milter-test-server — MTA側のmilterプロトコルを実装したプログラム

## 名前

milter-test-server - MTA側のmilterプロトコルを実装したプログラム

## 書式

`milter-test-server` [ オプション ... ]

## 説明

milter-test-serverはMTA側のmilterプロトコルを話します。つまり、MTA無しでmilterに接続することができます。現時点では、同様のツールは存在しないため、MTA+milterではなくmilter単体のテストを行うためには有用なツールです。例えば、以下のような用途に利用できます。

- milterの性能計測

- milterの動作確認

milter-test-serverは実行時間を表示するので、簡単な性能計測にも利用できます。このとき、MTAとは関係なくmilter単体での実行時間を確認できるため、MTA経由で試す場合よりも問題点の発見が容易になります。

milter-test-serverはヘッダや本文が変更された場合は、変更された内容を表示します。そのため、ヘッダや本文を変更するmilterのテストも容易に行うことができます。 C言語用テスティングフレームワークCutter などと組み合わせて自動化された単体テストを作成することもできます。

## オプション

--help | 利用できるオプションを表示して終了します。
--name=NAME | milter-test-serverの名前としてNAMEを使用します。名前は"{daemon_name}"マクロの値などで利用されます。 デフォルトはmilter-test-server（コマンドファイル名）です。

--connection-spec=SPEC

接続先のmilterのソケットを指定します。SPECの書式は次のうちのどれかです。

- unix:パス

- inet:ポート番号

- inet:ポート番号@ホスト名

- inet:ポート番号@[アドレス]

- inet6:ポート番号

- inet6:ポート番号@ホスト名

- inet6:ポート番号@[アドレス]

例:

- unix:/var/run/milter/milter-manager.sock

- inet:10025

- inet:10025@localhost

- inet:10025@[127.0.0.1]

- inet6:10025

- inet6:10025@localhost

- inet6:10025@[::1]

--negotiate-version=VERSION | クライアントへ送信するmilterプロトコルのバージョンとしてVERSIONを使用します。 デフォルトは8（Sendmail 8.14のデフォルトと同じ）です。
--connect-host=HOST | 接続元のホスト名としてHOSTを使用します。 このホスト名はmilterのxxfi_connect()コールバックに渡ります。
--connect-address=SPEC | 接続元のアドレスとしてSPECを使用します。SPECの書式は--connection-specの書式と同じです。 このアドレスはmilterのxxfi_connect()コールバックに渡ります。

--connect-macro=NAME:VALUE

xxfi_connect()コールバック時に送信するマクロを追加します。マクロの名前はNAMEで値はVALUEになります。複数のマクロを設定する場合はこのオプションを複数指定します。

xxfi_connect()コールバック時にclient_connectionsという名前で値が1のマクロを送信したい場合は以下のように指定します。

    --connect-macro client_connections:1

--helo-fqdn=FQDN | HELO/EHLO時の引数としてFQDNを使用します。 このfqdnはmilterのxxfi_helo()コールバックに渡ります。

--helo-macro=NAME:VALUE

xxfi_helo()コールバック時に送信するマクロを追加します。マクロの名前はNAMEで値はVALUEになります。複数のマクロを設定する場合はこのオプションを複数指定します。

xxfi_helo()コールバック時にclient_ptrという名前で値がunknownのマクロを送信したい場合は以下のように指定します。

    --helo-macro client_ptr:unknown

--envelope-from=FROM, -fFROM | MAIL FROM時の引数としてFROMを使用します。 このアドレスはmilterのxxfi_envfrom()コールバックに渡ります。

--envelope-from-macro=NAME:VALUE

xxfi_envfrom()コールバック時に送信するマクロを追加します。マクロの名前はNAMEで値はVALUEになります。複数のマクロを設定する場合はこのオプションを複数指定します。

xxfi_envfrom()コールバック時にclient_addrという名前で値が192.168.0.1のマクロを送信したい場合は以下のように指定します。

    --envelope-from-macro client_addr:192.168.0.1

--envelope-recipient=RECIPIENT, -rRECIPIENT | RCPT TO時の引数としてRECIPIENTを使用します。複数の宛先を指定したい場合は--envelope-recipientオプションを複数回指定してください。 このアドレスはmilterのxxfi_envrcpt()コールバックに渡ります。xxfi_envrcpt()は1つの宛先につき1回呼ばれるので、宛先が複数個ある場合はその分だけxxfi_envrcpt()が呼ばれます。

--envelope-recipient-macro=NAME:VALUE

xxfi_envrcpt()コールバック時に送信するマクロを追加します。マクロの名前はNAMEで値はVALUEになります。複数のマクロを設定する場合はこのオプションを複数指定します。

xxfi_envrcpt()コールバック時にclient_portという名前で値が2929のマクロを送信したい場合は以下のように指定します。

    --envelope-recipient-macro client_port:2929

--data-macro=NAME:VALUE

xxfi_data()コールバック時に送信するマクロを追加します。マクロの名前はNAMEで値はVALUEになります。複数のマクロを設定する場合はこのオプションを複数指定します。

xxfi_data()コールバック時にclient_nameという名前で値がunknownのマクロを送信したい場合は以下のように指定します。

    --data-macro client_name:unknown

--header=NAME:VALUE | 名前がNAMEで値がVALUEのヘッダを追加します。複数のヘッダを追加したい場合は--headerオプションを複数回指定してください。 このヘッダはmilterのxxfi_header()コールバックに渡ります。xxfi_header()は1つのヘッダにつき1回呼ばれるので、ヘッダが複数個ある場合はその分だけxxfi_header()が呼ばれます。

--end-of-header-macro=NAME:VALUE

xxfi_eoh()コールバック時に送信するマクロを追加します。マクロの名前はNAMEで値はVALUEになります。複数のマクロを設定する場合はこのオプションを複数指定します。

xxfi_eoh()コールバック時にn_headersという名前で値が100のマクロを送信したい場合は以下のように指定します。

    --end-of-header-macro n_headers:100

--body=CHUNK | 本文の一片としてCHUNKを追加します。複数のまとまりを追加する場合は--bodyオプションを複数回指定してください。 この本文のまとまりはmilterのxxfi_body()コールバックに渡ります。xxfi_body()は1つのまとまりにつき1回呼ばれるので、まとまりが複数個ある場合はその分だけxxfi_body()が呼ばれます。

--end-of-message-macro=NAME:VALUE

xxfi_eom()コールバック時に送信するマクロを追加します。マクロの名前はNAMEで値はVALUEになります。複数のマクロを設定する場合はこのオプションを複数指定します。

xxfi_eom()コールバック時にelapsedという名前で値が0.29のマクロを送信したい場合は以下のように指定します。

    --end-of-message-macro elapsed:0.29

--unknown=COMMAND | 未知のSMTPコマンドとしてCOMMANDを使います。 このコマンドはmilterのxxfi_unknown()コールバックに渡ります。xxfi_unknown()コールバックは、xxfi_envrcpt()コールバックとxxfi_data()コールバックの間に呼ばれます。
--authenticated-name=NAME | SMTP Authで認証されたユーザ名を指定します。SASLでのログイン名に相当します。このオプションを指定するとMAIL FROMのときに `{auth_authen}` の値として `NAME` を渡します。
--authenticated-type=TYPE | SMTP Authの認証に使用した方法を指定します。SASLでのログインメソッドに相当します。このオプションを指定するとMAIL FROMのときに `{auth_type}` の値として `TYPE` を渡します。
--authenticated-author=AUTHOR | SMTP Authで認証された送信者を指定します。SASL送信者に相当します。このオプションを指定するとMAIL FROMのときに `{auth_author}` の値として `AUTHOR` を渡します。
--mail-file=PATH | メールの内容として `PATH` にあるメールを使います。メール中にFrom:やTo:があった場合は、それらの値を送信元や宛先のアドレスとして使用します。
--output-message | milter適用後のメッセージを表示します。ヘッダを追加・削除したり、本文を置換するmilterの動作を確認したい場合はこのオプションを指定してください。
--color=[yes|true|no|false|auto] | --colorのみ、またはyes、trueを指定した場合はmilter適用後のメッセージを色付きで表示します。autoを指定した場合は、ターミナル上で実行していそうなら色を付けます。 既定値はnoです。色付けしません。
--connection-timeout=SECONDS | milterとの接続確立に使える時間を指定します。 `SECONDS` 秒以内に接続を確立できない場合はエラーになります。 既定値は300秒（5分）です。
--reading-timeout=SECONDS | milterからのレスポンスを待つ時間を指定します。 `SECONDS` 秒以内にレスポンスがこない場合はエラーになります。 既定値は10秒です。
--writing-timeout=SECONDS | milterへのコマンド送信に使える時間を指定します。 `SECONDS` 秒以内に送信できない場合はエラーになります。 既定値は10秒です。
--end-of-message-timeout=SECONDS | milterからのend-of-messageコマンドのレスポンスを待つ時間を指定します。 `SECONDS` 秒以内にレスポンスが完了しない場合はエラーになります。 既定値は300秒（5分）です。
--threads=N | Nスレッドで同時にリクエストを送ります。 既定値は0で、メインスレッドのみでリクエストを送ります。
--verbose | 実行時のログをより詳細に出力します。 「MILTER_LOG_LEVEL=all」というように環境変数を設定している場合と同じ効果があります。
--version | バージョンを表示して終了します。

## 終了ステータス

milterセッションが始まった場合は0で、そうでない場合は0以外になります。ソケットの書式が間違っている場合かmilter-test-serverがmilterに接続できない場合は、milterセッションを始めることができません。

## 例

以下の例では、ホスト192.168.1.29上の10025番ポートで待ち受けているmilterに接続します。

    % milter-test-server -s inet:10025@192.168.1.29

## 関連項目

milter-test-client.rd.ja (1), milter-performance-check.rd.ja (1)