Quickstart

1. Create an account in the Mailcycle app. An account is a twelve-word recovery phrase; there is no email or password.

2. Create an API key. API keys need the Operator plan or higher. In the app, open API, then the Keys tab. Give the key a name and select Create key. Copy the token now: it starts with mak_ and is shown once.

   export MAILCYCLE_API_KEY="mak_..."

   On Free or Personal, use a session token instead. See Authentication.

3. Check the key works.

   curl https://api.mailcycle.email/accounts/me \
     -H "Authorization: Bearer $MAILCYCLE_API_KEY"

   The response names the account and its plan.

4. See where you can create addresses.

   curl https://api.mailcycle.email/domains \
     -H "Authorization: Bearer $MAILCYCLE_API_KEY"

   { "domains": [{ "domain": "example-pool.email", "reserved": false, "tier": "free" }] }

5. List your email addresses.

   curl https://api.mailcycle.email/inboxes \
     -H "Authorization: Bearer $MAILCYCLE_API_KEY"

Creating addresses that receive mail

An address receives mail only once it has a public key, and that key is derived from your recovery phrase. The Mailcycle apps send it, and so does each SDK, which also opens the mail that arrives. With plain HTTP calls, an address created without publicKey refuses mail. See Email addresses.

Next

• Authentication: what a key can and cannot do.
• Reading mail: listing messages and what comes back.
• Sending mail: send from an address you own.
• SDKs: TypeScript, Python, Go, Rust, Swift, PHP, Java, .NET and Ruby clients that create addresses that receive mail, and read it.