Create a test email address
create_addressCreates a disposable email address in the project "Welcome To Test" for signing up to the app under test. It's on @mailclub.dev unless you choose another domain, and its name starts with "wel-". By default it also returns a fictional persona (first name, last name, username) to fill in sign-up forms; with age, the persona also gets a date of birth in that range, and with country, where it lives, for forms that ask. With password: true it also returns a strong password for the form, saved on the address; this is the only time it is shown here. It doesn't register anything in the app: sign up there yourself, or, if you can't open the app, give the person the address (and password) to sign up with. Then call wait_for_code or wait_for_link and pass on the code or link.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| age | No | Give the persona a date of birth (persona.date_of_birth, YYYY-MM-DD) for this age: adult (18 to 65), over21, under18 (15 to 17), under15 (13 or 14), under13 (8 to 12), any (8 to 80), or someone who turns 18 tomorrow or turned 18 today. Leave out for none. | |
| name | No | A custom name before the @. Random when left out. Generic names on their own (test, demo, info…) and words for running a mail domain (admin, postmaster…) are refused: add something of your own, such as test-acme. | |
| site | No | Where the account is used: the host or a page URL of the app under test, such as staging.example.com or localhost:3000. Kept as the host. | |
| test | No | With run_id: the test or step this call belongs to, shown beside what it saw in the report. | |
| label | No | What it is for, such as the flow being tested. | |
| domain | No | Mail domain. The project's default is mailclub.dev; choose another only if the app under test rejects it. | mailclub.dev |
| run_id | No | A run from start_run: what this call sees is added to its report. | |
| country | No | Where the persona lives (persona.country), as an ISO 3166-1 alpha-2 code such as GB or US, for forms that ask or for testing location-based content. Leave out for none. | |
| persona | No | Also generate a fictional first name, last name and username. | |
| password | No | Also generate a strong password (16 characters: upper- and lower-case letters, digits and symbols) and save it on the address, for sign-up forms that ask for a password. | |
| environment | No | Which environment of the app, such as staging, qa or local. | |
| date_of_birth | No | A date of birth to use instead of age, YYYY-MM-DD. | |
| lifetime_days | No | Days the address lasts, 1 to 30. |