Accounts and logins

A login is an address and password for SMTP and IMAP. Changing logins needs the admin role. See SMTP and IMAP.

GET /api/accounts

Every mailbox that can log in, plus any with settings on file, sorted by address.

Field	Meaning
address	The mailbox.
display_name	Optional name.
password	The login’s password.
username	A login name other than the address, if set.
allow_smtp, allow_imap	Which protocols it may use.
disabled	Switched off.
note	Your note.
messages	How many messages the mailbox holds.

Caution

This list includes passwords, and any role can read it. Give API keys only to systems you would trust with your test logins’ passwords.

POST /api/accounts

Creates a login. A new login may use both SMTP and IMAP unless you say otherwise.

{ "address": "app@yourcompany.test", "password": "a-long-password", "display_name": "Acme App",
  "username": "acme-app", "allow_smtp": true, "allow_imap": false, "note": "staging web app" }

Errors (400): “address must be an email address”, “username … is already used by …”, “login name already in use” (another universe in your organization has it), “choose a different password” (another organization uses that name with that password), or your plan’s login limit.

PATCH /api/accounts/{address}

Changes a login. Fields you leave out keep their values. Leaving out password (or sending "") keeps the current one; send "clear_password": true to remove it, which stops the login working.

{ "disabled": true }

DELETE /api/accounts/{address}

Turns the login off for good: no password, no login. The mailbox and its mail are kept.

POST /api/accounts/{address}/test

Checks a password the way SMTP and IMAP do.

Field	Meaning
password	The password to try.
username	The login name to try. Defaults to the address in the path.
proto	smtp or imap to test only one.

{ "smtp": { "ok": true, "address": "app@yourcompany.test" }, "imap": { "ok": false, "address": "" } }

Connection details

Call	What it returns
GET /api/connection	The server’s domain, its services (SMTP, SMTPS, IMAP, IMAPS with address, port and security), auth_mechanisms (PLAIN, LOGIN), plain_auth_allowed, smtp_auth_required, and the certificate (self_signed, sha256 fingerprint, subject).
GET /api/connection/cert	The TLS certificate as a PEM file, simmail.crt.

Who am I

Call	What it returns
GET /api/me	Who is asking. For an API key: kind: "key" and key with prefix, name, universe and role. For a signed-in person: user, orgs. Always universes.
GET /api/universes	The universes you can open, each with id, name, org, created and your role.
GET /api/status	A summary of the universe: counts of mailboxes, messages, personas, cases and pending_jobs, the clock, and writer (gemini or templates).