MillionSend Docs

Retrieve an inbox's safety rules

GET
/inboxes/{inbox_id}/safety

MillionSend extension: who may write in, screening, code extraction, what the inbox may send and where it forwards.

Path Parameters

inbox_id*string

The inbox ID

Formatuuid

Response Body

Safety rules

application/json
  1. response
object*"inbox_safety"
Value in"inbox_safety"
inbox_id*string
Formatuuid
accept_from*string

Who may write in: anyone; verified (DMARC-aligned senders, known threads, the allowlist); allowlist only. Mail that fails is quarantined.

Value in"anyone""verified""allowlist"
allowlist*array<string>

"local@domain" (exact) or "*@domain" (the domain and its subdomains). On the shared domain it only lets mail in

Itemsitems <= 500
owner_addresses*array<string>

Owners besides the team members' login addresses; ignored on the shared domain

Itemsitems <= 50
screening*boolean

Score external mail for prompt injection (agent inboxes only)

extract_codes*boolean

Expose extracted codes and sign-in links

send_policy*string

What the inbox may send without a person's approval. On the shared domain "allowlist" answers 422, and so does "open" unless the instance lets the team start conversations there (paid plans only)

Value in"reply_only""allowlist""open"
require_approval*boolean

Every send waits for a person

private_codes*boolean

Received codes and sign-in links can't be sent on to anyone but owners

send_cap*integer

Unattended recipients per UTC day; null: no cap. 1-50 on the shared domain

forward_to*array<string>

Forward every delivered message to these team member or owner addresses; team members only on the shared domain

Itemsitems <= 5
Example Request
curl -X GET 'https://api.millionsend.com/inboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08/safety'
Example Response
{  "object": "inbox_safety",  "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",  "accept_from": "anyone",  "allowlist": [    "string"  ],  "owner_addresses": [    "string"  ],  "screening": true,  "extract_codes": true,  "send_policy": "reply_only",  "require_approval": true,  "private_codes": true,  "send_cap": 0,  "forward_to": [    "string"  ]}