email

POST /v1/hooks/ses

This is not a path you call. Amazon SNS delivers SES events here over an HTTPS subscription. Authentication is not a token but an SNS signature — the request is accepted only when the certificate URL is https on sns.<region>.amazonaws.com and the topic matches the server's RUNLOT_SES_SNS_TOPIC_ARN (otherwise 403). SubscriptionConfirmation completes automatically by sending a GET to SubscribeURL. Returns 501 if the server has no topic ARN. Client libraries do not call this.

operationId sesHook

Request body: text/plain · string

GET /v1/orgs/{orgSlug}/projects/{projectName}/email

Whether email is granted, plus the address, sender, hourly cap, and recent sent and received counts. Even without a grant, address and from come populated, so you can see what the address would be if you turned it on; granted is the real state.

Requires viewer or higher.

operationId getEmail

POST /v1/orgs/{orgSlug}/projects/{projectName}/email

This is idempotent. There is no request body — the address is derived (<project>.<org>.<mail-domain>), and the plan determines the limit. The address is fixed to the project name at the time of the grant.

Once enabled, env.email is connected to the worker shortly afterwards, and mail sent to that address reaches the worker's email() handler. Sending and receiving turn on together — one domain serves both directions.

Requires member or higher. Audited as email.grant.

operationId grantEmail

DELETE /v1/orgs/{orgSlug}/projects/{projectName}/email

Mail sent to that address now gets 550 — the sending MTA receives a bounce and does not retry. This is idempotent.

Requires admin or higher. Audit event email.revoke.

operationId revokeEmail

GET /v1/orgs/{orgSlug}/projects/{projectName}/email/domains

The project's own sending domains and their verification state. Each row carries the exact DNS records to publish.

Requires viewer or higher.

operationId listEmailDomains

POST /v1/orgs/{orgSlug}/projects/{projectName}/email/domains

Registers the domain for sending with DKIM and answers with the records to publish: three <token>._domainkey.<domain> CNAMEs (required), an SPF TXT and a DMARC TXT (both advisory). The domain becomes usable in env.email.send({ from }) only once it reads verified.

publish: true writes the records straight into the zone when Runlot hosts one covering the domain and it belongs to the same organization. Records you wrote yourself are never overwritten.

A repeat call is not an error and does not change the tokens — records already published stay correct. Requires member or higher. Audited as email.domain.add.

operationId addEmailDomain

Request body: application/json · object

POST /v1/orgs/{orgSlug}/projects/{projectName}/email/domains/{domain}/verify

Re-checks the domain's DKIM state now and updates the row. A background check does the same once a minute while a domain is pending; this is the button for when you have just published the records and do not want to wait.

If the check cannot be completed, the state is left where it is and the reason appears in lastError.

Requires member or higher.

operationId verifyEmailDomain

DELETE /v1/orgs/{orgSlug}/projects/{projectName}/email/domains/{domain}

Deletes the sending identity and the row, and removes any records Runlot wrote into a zone it hosts. Shortly afterwards every env.email.send({ from }) naming this domain is refused with from_not_verified.

Removing one that is not there is also a 204. Requires admin or higher. Audited as email.domain.remove.

operationId removeEmailDomain

GET /v1/orgs/{orgSlug}/projects/{projectName}/email/log

One line per sent and received message, newest first: envelope, outcome, size, and SPF result. The raw message is at …/log/{mailId}/raw.

Retention follows the plan — 30 days on Free, 365 days on Pro (keepDays).

Requires viewer or higher.

operationId listMailLog

GET /v1/orgs/{orgSlug}/projects/{projectName}/email/log/{mailId}

An id outside the project returns 404 — you cannot probe another project's logs by id. Requires viewer or higher.

operationId getMailLog

GET /v1/orgs/{orgSlug}/projects/{projectName}/email/log/{mailId}/raw

The raw message as-is, including headers. For received mail this includes the Received and Authentication-Results headers Runlot added; for sent mail it is assembled from what was submitted. Downloads as .eml. Rows with no raw message (hasRaw: false) return 404. Requires viewer or higher.

operationId getMailLogRaw