コンテンツにスキップ

proxymail-qa パッケージには、バージョン 0.13.0 からコマンドがあります。手動でテストしながらターミナルで、npm スクリプトで、JetBrains や VS Code の実行構成で、または CI のステップで使えます。Node 18 以降で動作し、npx 以外のインストールは不要です。

  1. API キー を作成し、PROXYMAIL_QA_API_KEY に設定します。コマンドはキーを環境変数からのみ読み取り、オプションからは読み取らないため、シェルの履歴に残りません。

    export PROXYMAIL_QA_API_KEY=qa_...
  2. ターミナルでは、アドレス、パスワード、ペルソナの名前、ユーザー名、生年月日、国が表示され、そのままサインアップフォームに入力できます。パスワードはアドレスに保存され、表示されるのはこの一度だけです。

    npx proxymail-qa new --password --country JP
  3. そのアドレスでサインアップしてから、次を実行します。

    待機は、--timeout を指定しない限り 30 秒です。何も届かない場合は、Proxy Mail QA がわかる範囲で理由を示し、終了コード 1 で終了します。

    npx proxymail-qa wait-code k7f2@mailclub.dev
    npx proxymail-qa wait-link k7f2@mailclub.dev --type reset
コマンド 機能
new ペルソナ付きのテスト用アドレスを作成します。--password、--country、--age または --dob、--one-name、--label、--site、--environment、--days、--no-persona
wait-code <address> サインインコードを待ちます。クーポンには --type coupon、--since、--service、--unused、--timeout
wait-link <address> リンクを待ちます。--type verify、reset、magic_signin または invite(カンマ区切りで複数可)、モバイルアプリを開くリンクには --app
persona <address> アドレスのペルソナを表示します
form-values <file> フォームの各フィールドに入力する内容:下記を参照

npx proxymail-qa help <command> でコマンドのオプションを一覧表示します。どのコマンドにも --json を付けると、応答全体を JSON で取得できます。

出力がパイプや変数に渡されると、コマンドは値だけを出力します。アドレス、コード、リンクのいずれかです。new --password はアドレスを出力し、2 行目にパスワードを出力します。

ADDRESS=$(npx proxymail-qa new --site staging.example.com --environment staging)
# …sign up with $ADDRESS…
CODE=$(npx proxymail-qa wait-code "$ADDRESS" --timeout 60)

パスワードはスクリプトで使えるように出力されます。変数に保持し、CI のログには出力しないでください。実行中(GitHub Action が設定する PROXYMAIL_QA_RUN)は、すべての呼び出しが実行のレポートに追加されます。

チーム全員が同じコマンドを実行できるよう、npm スクリプトとして追加します。

package.json
{
"scripts": {
"inbox": "proxymail-qa new --password --site localhost:3000 --environment local",
"code": "proxymail-qa wait-code"
}
}

npm run inbox、次に npm run code -- k7f2@mailclub.dev。JetBrains の IDE では、スクリプトごとに種類 npm の実行構成を追加するか、npx proxymail-qa new を実行する Shell Script 構成を追加します。

form-values はフォームのフィールドを列挙した JSON ファイルを受け取り、新しいアドレス、または --address で指定したアドレスをもとに、各フィールドに入力する内容を返します。Node.js クライアントの formValues と同じように、プロジェクトの カスタムフィールド と、フォームが求める名前、日付、パスワードを埋めます。

signup-form.json
{
"fields": [
{ "id": "email", "type": "email", "label": "Email" },
{ "id": "name", "label": "Full name" },
{ "id": "team", "type": "select", "label": "Team size", "options": [{ "value": "1-10" }, { "value": "11-50" }] }
],
"page": "/signup"
}
npx proxymail-qa form-values signup-form.json --site staging.example.com --country PK

JSON を出力します。アドレス、ペルソナ、作成された場合はパスワード、フィールドごとの値です。コマンドラインのオプションは、ファイル内の同じオプションより優先されます。標準入力からフィールドを読み取るには、ファイル名の代わりに - を使います。

コード 意味
0 完了
1 API が拒否したか、時間内に何も届きませんでした。理由は標準エラーに出力されます
2 コマンドが誤っているか、PROXYMAIL_QA_API_KEY が設定されていません

このページについて質問がありますか?

質問はどの言語でもかまいません。ドキュメントからすぐに回答を得ることも、Proxy Mail QA チームに質問を送ることもできます。チームからの返信は英語です。