inboxes

Inspect sending rules

Shows the inbox's recipient restrictions. They apply to every way of sending: send, reply, reply-all, forward and drafts.

With enabled: false the inbox can send to anyone, even if addresses or domains are saved. With enabled: true, every To, Cc and Bcc recipient must match an entry in addresses or domains, or the send is refused with 403 recipient_not_allowed; with both lists empty, the inbox can't send.

An address entry matches exactly: the local part is case-sensitive, and plus tags and dots count. A domain matches without regard to case and only itself, not its subdomains; international domains are listed in punycode.

These rules can be changed only in Account → Sending rules, not through the API. Sending rules guide

get/v1/inboxes/{inbox_id}/sending-policy

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/inboxes/{inbox_id}/sending-policy
  • Auth: HTTP bearer

Path parameters

inbox_idstring required

Cherami resource ID returned by the API.

Response

Success.

inbox_idstring required

Cherami resource ID.

enabledboolean required
addressesstring[] required
domainsstring[] required
revisioninteger required

Saved policy version; zero when unconfigured.

Changes

No recorded changes to this operation across all 1 revision of this API.