Skip to main content
POST
Send computer email

Authorizations

Authorization
string
header
required

A Cool Computers API key, user access token, or claimed agent access token in the Authorization header. Follow https://www.cool.computer/auth.md for agent registration and https://www.cool.computer/authentication.md for direct user credentials.

Headers

Idempotency-Key
string

A caller-generated key for safely retrying this side effect. The server retains the key and response for 24 hours. Reusing it with the same request replays the original response; reusing it with different input returns 409.

Required string length: 1 - 128
Pattern: ^[!-~]+$
Example:

"req_01J6M6Y9TF9Q9QF6M1ZP8K4R2A"

Path Parameters

id
string
required

Stable public computer identifier.

Minimum string length: 1
Example:

"cmp_123"

Body

application/json
to
string<email>
required
subject
string
required

Subject line, limited to 998 bytes.

Minimum string length: 1
text
string
required

Plain-text body. The text and HTML bodies together are limited to 1 MiB.

html
string

HTML body. The text and HTML bodies together are limited to 1 MiB.

Response

One inbound or outbound email.

id
string
required
direction
enum<string>
required
Available options:
inbound,
outbound
status
enum<string>
required
Available options:
received,
pending,
sent,
failed,
ambiguous,
rejected
from
string
required
envelope_from
string
required
to
string[]
required
subject
string
required
created_at
string<date-time>
required
sender_authentication
string
authenticated_sender
string
text
string
html
string
message_id
string
in_reply_to
string
error
string
read_at
string<date-time> | null