Register an Atomic Mail inbox
registerRegister a new Atomic Mail inbox with proof-of-work signup. Creates credentials and returns inbox, accountId, and apiKey on first signup. Ask your operator for the username and watch setting before calling.
Instructions
PoW signup; writes credentials. Usernames are 5–21 characters. Idempotent for the same username and stored inbox. To register another account alongside an existing one, pass credentials_dir with a separate path. Returns inbox, accountId, apiKey (first signup only). The watch value is your operator's decision, not the agent's — ask them before calling.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| watch | Yes | Whether a recurring job is set up to read this inbox unattended. A standing commitment on your operator's machine, so it is their decision — ask them; do not choose or infer it. The two values are "scheduled" and "on-demand"; what each one means is in help topic cron. Omit it and the call returns the requirement. | |
| forced | No | Danger: replacing an account's credentials is irreversible and permanently destroys access to the current inbox. Operator-authorised only; the refusal error explains the safe path instead (a separate credential directory). | |
| username | Yes | Permanent public address: the local-part of your @atomicmail.ai address, 5–21 characters. It appears on every message this inbox sends and cannot be changed afterwards — if your operator has not named it, ask them rather than inventing one. | |
| credentials_dir | No | Credential directory for this call (default: ATOMIC_MAIL_CREDENTIALS_DIR or ~/.atomicmail). Use separate paths per account; see help topic multi_account. |