Documentation Index
Fetch the complete documentation index at: https://docs.qawolf.com/llms.txt
Use this file to discover all available pages before exploring further.
Get Started
@qawolf/emails lets a flow receive and send email through QA Wolf-managed
test inboxes.
Start with mail.inbox(...).
import { mail } from "@qawolf/emails";
const { emailAddress, waitForMessage } = await mail.inbox({ new: true });
await page.getByLabel("Email").fill(emailAddress);
await page.getByRole("button", { name: "Send magic link" }).click();
const message = await waitForMessage({});
What You Get Back
mail.inbox(...) returns a handle scoped to one address.
const inbox = await mail.inbox({ new: true });
inbox.emailAddress;
await inbox.waitForMessage({});
await inbox.waitForMessages({ minCount: 2 });
await inbox.sendMessage({
to: ["support@example.com"],
subject: "Test message",
text: "Hello from a QA Wolf flow",
});
Use A Unique Address By Default
For most tests, pass new: true.
const inbox = await mail.inbox({ new: true });
Pin Waiting To The Action
Capture after immediately before the app action that should send email.
const after = new Date();
await page.getByRole("button", { name: "Send code" }).click();
const message = await inbox.waitForMessage({ after });
Runtime Setup
In normal QA Wolf runs, the runner configures the email client. Local harnesses
can configure it explicitly with the QA Wolf API.
import { configureEmailsClient, createEmailsClient } from "@qawolf/emails";
const client = await createEmailsClient({
apiKey: process.env["QAWOLF_API_KEY"]!,
pollForEmailsDefaultTimeoutMs: 300_000,
teamId: process.env["QAWOLF_TEAM_ID"],
url: process.env["QAWOLF_API_URL"]!,
waitForMessagesDefaultDelayMs: 15_000,
});
configureEmailsClient(client);
Next Steps
