命令行
本页由英文自动翻译。
阅读英文版proxymail-qa 包从 0.13.0 版本起带有一个命令。你可以在手动测试时在终端里使用它,也可以在 npm 脚本、JetBrains 或 VS Code 运行配置,或 CI 步骤中使用。它需要 Node 18 或更高版本,除 npx 外无需安装其他东西。
设置 API 密钥
Section titled “设置 API 密钥”创建一个 API 密钥 并将其设为
PROXYMAIL_QA_API_KEY。该命令只从环境变量读取密钥,从不从选项读取,所以密钥不会出现在你的 shell 历史中。export PROXYMAIL_QA_API_KEY=qa_...创建测试地址
Section titled “创建测试地址”在终端中,它会显示地址、密码,以及 persona 的姓名、用户名、出生日期和国家,可以直接填入注册表单。密码保存在该地址上,只显示这一次。
npx proxymail-qa new --password --country JP等待验证码或链接
Section titled “等待验证码或链接”用该地址注册,然后:
等待默认持续 30 秒,除非你指定
--timeout。如果什么都没收到,它会尽 Proxy Mail QA 所知说明原因,并以 1 退出。npx proxymail-qa wait-code k7f2@mailclub.devnpx proxymail-qa wait-link k7f2@mailclub.dev --type reset
| 命令 | 作用 |
|---|---|
new |
创建一个带 persona 的测试地址。--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> |
显示该地址的 persona |
form-values <file> |
表单每个字段应填写的内容:见下文 |
npx proxymail-qa help <command> 列出命令的选项。在任意命令后加 --json,可获得 JSON 格式的完整结果。
在脚本和 CI 中
Section titled “在脚本和 CI 中”当输出指向管道或变量时,命令只打印值:地址、验证码或链接。new --password 先打印地址,再在第二行打印密码。
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 日志。在一次运行中(PROXYMAIL_QA_RUN,由 GitHub Action 设置),每次调用都会加入该运行的报告。
作为 npm 脚本,团队就能运行相同的命令:
{ "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 相同。
{ "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:地址、persona、生成的密码(如有),以及每个字段的值。命令行上的选项优先于文件中的同名选项。用 - 代替文件名,可从标准输入读取字段。
| 代码 | 含义 |
|---|---|
| 0 | 完成 |
| 1 | API 拒绝了请求,或者没有按时收到内容。原因输出在标准错误中 |
| 2 | 命令有误,或者未设置 PROXYMAIL_QA_API_KEY |
对本页有疑问?
可以用任何语言提问。文档可以立即回答,你也可以把问题发给 Proxy Mail QA 团队,他们会用英文回复。