CLI command

probierz mail-code

Give a journey the code a product e-mailed to a test address, read through the `message-list` operation of Stado's `mail` family, so no journey holds mailbox credentials.

Invocation#

Shell
probierz mail-code --organization <ID> --to <ADDRESS> --since <RFC3339> [--sender <TEXT>] --digits <N>

Required inputs and options#

  • --organization is the test mailbox's organization in the mail alternative; --to the address the product sent to; --since the instant the journey's step started.
  • --sender keeps only mail whose From contains the text; --digits is the code's length as the product's mail states it.

Output and state effects#

Calls stado capabilities call mail --operation message-list with the organization, recipient, instant and sender, and prints {"code", "messageId", "receivedAt"} from the newest message that holds one: the first run of exactly that many digits in its subject or body. Nothing is written.

Exact refusals#

  • No mail alternative answering is refused with Stado's sentence and the stado capabilities command that fixes it.
  • answer-malformed (exit 1): an answer that is not JSON, or JSON without a list of messages, is refused naming the command Stado was asked and what it said; the fix is a Stado release whose mail family answers as Probierz reads it (stado product update stado).
  • No message since the instant, or none with a code of that length, is refused naming the address, the instant and how many messages were read; retrying may find it once the mail is imported.

Declared refusals#

What probierz refusals list declares for this command at revision d2cd6156e8b8dc6204dab7b46ec0b34b2bb03cea (probierz 0.1.7 (revision unknown, not built from a git checkout)): each cause's id, the operation declaring it, its exit status and code, and its remedy.

  • state-blank (probierz.config, exit 1, config): finding Probierz's state directory: PROBIERZ_STATE_DIR is set but blank, so it names no directory. set PROBIERZ_STATE_DIR to an absolute directory, or unset it so .probierz in the home directory is used.
  • state-relative (probierz.config, exit 1, config): finding Probierz's state directory: PROBIERZ_STATE_DIR names {path}, which is not an absolute path, so it would mean a different directory in every working directory. set PROBIERZ_STATE_DIR to an absolute directory.
  • unreadable (probierz.config, exit 1, config): reading this instance's configuration at {file}: the file cannot be read: {error}. make {file} a file this user can read, or remove it to set no key.
  • malformed (probierz.config, exit 1, config): reading this instance's configuration at {file}: the file is not a JSON object of keys: {error}. write {file} again with probierz config set, or remove it to set no key.
  • stored-unknown (probierz.config, exit 1, config): reading this instance's configuration at {file}: it holds {key}, which no part of this Probierz reads (a key a release before or after this one declared). remove it with probierz config unset {key}.
  • stored-invalid (probierz.config, exit 1, config): reading {key} from this instance's configuration at {file}: it holds {value}, which is not a {kind}. set it again with probierz config set {key} <value>, or remove it with probierz config unset {key}.
  • unwritable (probierz.config, exit 1, config): writing this instance's configuration at {file}: {step} failed: {error}. make {directory} a directory this user can write, or point PROBIERZ_STATE_DIR at one.
  • key-unknown (probierz.config, exit 2, refused): naming a configuration key: {key} is no key any part of Probierz reads. name one of the listed keys; probierz config list prints what each decides.
  • value-invalid (probierz.config, exit 2, refused): setting {key}: {value} is not a {kind}: {why}. give {key} a {kind}.
  • stado-missing (probierz.alternatives, exit 1, config): asking Stado which alternative answers: {command}: Stado could not be started: {error}. install Stado (the stado release installer at stado://releases/stado/<version>/<platform>/install.sh) so its alternatives can be asked.
  • none-answers (probierz.alternatives, exit 69, infra_down): finding an alternative of {family} for Probierz: no alternative answered {command}: {cause}. make one of the alternatives Stado names answer (stado capabilities list {family}), or select another order with stado capabilities select {family}.
  • answer-malformed (probierz.alternatives, exit 1, config): reading Stado's answer to {command}: {error}. update Stado to the release whose answer Probierz reads (stado product update stado).
  • program-failed (probierz.alternatives, exit 1, refused): {command}: {cause}. fix what the provider names, or ask Stado for the next alternative with stado capabilities resolve --failed <provider>.
  • placement-unset (probierz.alternatives, exit 1, config): opening a browser: this instance has not decided where a browser may run (browser.placement). run probierz config set browser.placement stado (only on a host Stado places the run on) or local.
  • placement-refused (probierz.alternatives, exit 1, refused): opening a browser: browser.placement is stado and this process is not a job Stado placed. run it through Stado: probierz remote run web --app <app> --host <host>, or the same verb under probierz remote.

Source snapshot#

Generated from the Rust binaries at revision 99a74945a3598a8d73b6c6cbe5aae4f283becea3 of Probierz's private source repository.

Combined help SHA-256: 77529678a61237f774b59e76df0d1907cb749ef5da56d2ed913b040793b7d30b; binary SHA-256: be9e0eaff0e6ea50403a0c6f6d467697a4eac676f9523b8dc13a596d2b5526c5.