Try real email with the sandbox sender, then use your verified domains through the HTTP API.
Email uses Amazon SES for delivery. Arkor manages the SES account; you do not need AWS credentials. The first version supports transactional messages and attachments. Marketing campaigns and bulk sending are outside this version.
Try email before verifying a domain
Use the fixed sender onboarding@sandbox.arkor.dev to send real email to the verified Arkor
registration addresses of current team members. No domain verification or Cloudflare connection
is needed for this sender. Every recipient in to, cc and bcc must qualify; other addresses,
including aliases of a registered address, are rejected. Removing a member or changing their
registered email removes the old address from the allowed recipients.
- Open Email in your project's sidebar and check Sandbox email for availability.
- Enable email for the project in Sending settings and save. You can leave all domains unselected.
- Create a sending key for the environment you will use.
- Use
onboarding@sandbox.arkor.devasfromand a qualifying team member's registered address asto.
The default sandbox limits are shared across the team's projects and environments: 100 recipients per rolling 24 hours, 5 recipients per minute, and 25 MiB of encoded request data per rolling 24 hours. Request data includes JSON and base64 attachment encoding. The dashboard shows the effective limits, which may be lower. Sandbox delivery still requires the platform's provider setup and sending availability; enabling a project cannot bypass them.
Production keys can use the sandbox sender. Preview and development keys can use it after enabling
their project switches. These sends are real delivery; the sandbox sender is different from
test: true, which only simulates acceptance without delivering email.
Prepare a sending domain
- Connect the team's Cloudflare account in Arkor Domains.
- Open Email in a project's sidebar and enter a domain from that account.
- Choose Add domain. Arkor finds the Cloudflare zone and prepares verification, DKIM and custom MAIL FROM records. Existing conflicting records are reported instead of overwritten.
- Wait until the domain is Ready. Check setup asks Arkor to reconcile its setup again.
- Select the domain in Sending settings, enable the project and save.
Sending domains are shared by the team, but each project needs an explicit grant. Adding a domain does not grant every project access. Removing a shared domain stops all projects in the team from using it. Owners and admins manage settings, domains and keys; team members can view status and history.
Sending from your own domains also requires the operator to enable verified-domain delivery and configure explicit team and project limits. The dashboard shows this status separately from sandbox availability. Project settings cannot enable operator delivery or raise those limits.
Preview and development sends are off by default. Their project switches allow real delivery, so enable them only when you intend to send to real recipients. Production, preview and development keys each belong to one project and one environment. The JSON message cannot change that identity.
Send through HTTP
Create a sending key in the project's Email page. Copy it when shown: the plaintext is returned once. Keep it in a server secret and revoke it when no longer needed. Sending keys cannot manage domains, settings or other projects.
The API uses the control project's ID. List your projects
to find it. This example sends real sandbox email; replace member@example.net with a current team
member's verified Arkor registration address:
curl -X POST "https://api.arkor.dev/v1/projects/$PROJECT_ID/email/messages" \
-H "authorization: Bearer $ARKOR_MAIL_KEY" \
-H "content-type: application/json" \
-H "idempotency-key: sandbox-hello-123" \
-d '{"from":"onboarding@sandbox.arkor.dev","to":["member@example.net"],"subject":"Hello from Arkor","text":"Your sandbox email arrived."}'Add "test": true to check acceptance without external delivery and record a simulated message.
Omit it to request real sending once the platform, project and environment are ready. For other
recipients, use a sender such as orders@example.com from a verified domain granted to the project,
with verified-domain delivery enabled. The response identifies the accepted message. Acceptance
is not a promise of delivery.
Use a stable Idempotency-Key for each logical message. Within 24 hours, repeating the same key and
message returns the same receipt; changing the message under that key is rejected. If provider
submission has an unknown outcome, Arkor records it as Outcome unknown instead of automatically
sending another copy.
Read the receipt with the same key:
curl "https://api.arkor.dev/v1/projects/$PROJECT_ID/email/messages/$MESSAGE_ID" \
-H "authorization: Bearer $ARKOR_MAIL_KEY"The Email history page shows current aggregate and recipient delivery states, including partial delivery, bounces and complaints. Refresh to request current state. It does not display message bodies or attachment contents.
Message shape and attachments
Provide from, a nonempty to array, subject, and at least one of text or html. Optional
fields include cc, bcc, replyTo and attachments. Up to 50 total recipients and 20 attachments
are accepted, with a 5 MiB encoded limit for each request. The sender must be
onboarding@sandbox.arkor.dev or use a verified domain granted to the project. The sandbox recipient
restriction applies to every to, cc and bcc address; sending from your verified domain permits
other recipient addresses.
An attachment is included in the JSON request as base64:
{
"filename": "receipt.txt",
"contentType": "text/plain",
"content": "VGhhbmsgeW91Lg==",
"disposition": "attachment"
}Use disposition: "inline" and contentId for an inline image referenced with cid: in HTML.
Arkor does not fetch arbitrary attachment URLs. See the
OpenAPI reference for request fields and errors.
Hosted deployments receive the platform's ARKOR_MAIL capability when configured. It does no work
until explicitly called. The upwind email SDK is a separate integration; these instructions use
the HTTP API.
Usage and retention
The dashboard reports submitted recipients, body and attachment bytes, and unknown submissions. Email pricing is not configured in this version. These quantities have no monetary estimate and do not enter the priced hosting meters.
Message payloads and attachments are retained for up to 7 days, delivery metadata for 30 days, and usage quantities for 13 months. Revoking permission or deleting a project prevents further sending; shared team domains remain available to the team's other granted projects.