Skip to main content
The top-level mail facade exposes:
  • mail.inbox(options?)
mail.inbox(...) is a thin facade over the currently configured emails client. If no client has been configured, it throws a setup error that points callers to configureEmailsClient(...). Example:

Inbox handle

The returned inbox handle exposes:
  • emailAddress
  • sendMessage(...)
  • waitForMessage(...)
  • waitForMessages(...)
The exported wait type is shared by both wait methods. Each method uses only some of its fields. Pass {} when you want default wait behavior. Example:

Current GetInboxOptions

Validation and behavior:
  • new: true derives a unique address based on the current default
  • delimiter customizes the separator used for derived addresses
  • address must come from the allowed workspace address set
  • omitting address triggers a lookup of the workspace default address
If teamId is missing from the runtime client configuration, inbox creation fails. Examples:

sendMessage(...)

Input shape:
Behavior:
  • to is always an array of strings
  • at least one of html or text is required
  • QA Wolf base64-encodes attachments before sending the request to the email service
Return shape:
Example:

Parsed email shape

Both wait methods below return this shape:
QA Wolf derives urls by parsing links from the HTML body. Example:

waitForMessage(...)

Method options:
waitForMessage(...) uses:
  • after when it is provided
  • otherwise the time when mail.inbox(...) was called
  • timeout when it is provided
It returns one ParsedEmail and throws if no message arrives in time. Example:

waitForMessages(...)

Method options:
Behavior:
  • it uses after when provided, otherwise the time when mail.inbox(...) was called
  • it waits for delay first
  • it polls until at least minCount messages are found, or until timeout
  • it returns the matching parsed emails
Example:
Last modified on September 11, 2026