Línea de comandos
Traducido automáticamente del inglés.
Leer en inglésEl paquete proxymail-qa incluye un comando, desde la versión 0.13.0. Úsalo en una terminal mientras pruebas a mano, en scripts de npm, en una configuración de ejecución de JetBrains o VS Code, o en un paso de CI. Funciona con Node 18 o posterior y no necesita instalar nada aparte de npx.
Define la clave de API
Sección titulada «Define la clave de API»Crea una clave de API y defínela como
PROXYMAIL_QA_API_KEY. El comando lee la clave solo del entorno, nunca de una opción, así que no queda en el historial de tu shell.export PROXYMAIL_QA_API_KEY=qa_...Crear una dirección de prueba
Sección titulada «Crear una dirección de prueba»En una terminal muestra la dirección, la contraseña y el nombre, el nombre de usuario, la fecha de nacimiento y el país de la persona, listos para escribir en el formulario de registro. La contraseña se guarda en la dirección y se muestra solo esta vez.
npx proxymail-qa new --password --country JPEspera el código o enlace
Sección titulada «Espera el código o enlace»Regístrate con la dirección y luego:
Una espera dura 30 segundos, salvo que indiques
--timeout. Si no llega nada, explica el motivo hasta donde Proxy Mail QA puede saberlo y termina con 1.npx proxymail-qa wait-code k7f2@mailclub.devnpx proxymail-qa wait-link k7f2@mailclub.dev --type reset
Comandos
Sección titulada «Comandos»| Comando | Qué hace |
|---|---|
new |
Crea una dirección de prueba con una persona. --password, --country, --age o --dob, --one-name, --label, --site, --environment, --days, --no-persona |
wait-code <address> |
Espera un código de inicio de sesión. --type coupon para un cupón, --since, --service, --unused, --timeout |
wait-link <address> |
Espera un enlace. --type verify, reset, magic_signin o invite (varios separados por comas), --app para el enlace que abre una app móvil |
persona <address> |
Muestra la persona de la dirección |
form-values <file> |
Qué escribir en cada campo de un formulario: consulta más abajo |
npx proxymail-qa help <command> lista las opciones de un comando. Agrega --json a cualquier comando para obtener la respuesta completa en JSON.
En scripts y CI
Sección titulada «En scripts y CI»Cuando su salida va a una tubería o a una variable, un comando imprime solo el valor: la dirección, el código o el enlace. new --password imprime la dirección y luego la contraseña en una segunda línea.
ADDRESS=$(npx proxymail-qa new --site staging.example.com --environment staging)# …sign up with $ADDRESS…CODE=$(npx proxymail-qa wait-code "$ADDRESS" --timeout 60)La contraseña se imprime para que un script pueda usarla: guárdala en una variable y no la muestres en un registro de CI. En una ejecución (PROXYMAIL_QA_RUN, que define la Action de GitHub), cada llamada se agrega al informe de la ejecución.
Como scripts de npm, para que el equipo ejecute los mismos comandos:
{ "scripts": { "inbox": "proxymail-qa new --password --site localhost:3000 --environment local", "code": "proxymail-qa wait-code" }}npm run inbox, luego npm run code -- k7f2@mailclub.dev. En los IDE de JetBrains, agrega una configuración de ejecución de tipo npm para cada script, o una configuración Shell Script que ejecute npx proxymail-qa new.
Valores de formulario
Sección titulada «Valores de formulario»form-values recibe un archivo JSON que lista los campos de un formulario y responde con qué escribir en cada uno, a partir de una dirección nueva o de una que indiques con --address. Rellena los campos personalizados del proyecto y los nombres, fechas y contraseñas que pide un formulario, como hace el formValues del cliente de Node.js.
{ "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 PKImprime JSON: la dirección, la persona, la contraseña si se creó una y un valor por campo. Las opciones de la línea de comandos tienen prioridad sobre las mismas del archivo. Usa - en lugar de un nombre de archivo para leer los campos desde la entrada estándar.
Códigos de salida
Sección titulada «Códigos de salida»| Código | Significado |
|---|---|
| 0 | Listo |
| 1 | API lo rechazó, o no llegó nada a tiempo. El motivo está en la salida de error estándar |
| 2 | El comando era incorrecto, o PROXYMAIL_QA_API_KEY no está definida |
¿Tienes una pregunta sobre esta página?
Pregunta en cualquier idioma. La documentación puede responderte de inmediato, o puedes enviar tu pregunta al equipo de Proxy Mail QA, que responde en inglés.