policy

Set correspondent policy mode

Set the filtering mode for one direction of a scope's policy, without touching rules. Inbox-scoped keys are rejected. A pod-scoped key may mutate its own pod or an inbox in that pod, never account-wide policy. Pod keys cannot set none.

put/v1/policy/mode

Request

  • Base URL: https://api.openmail.sh
  • URL: https://api.openmail.sh/v1/policy/mode
  • Auth: HTTP bearer

Query parameters

podIdstring

Confine the operation to one pod's policy. Accepts the pod ID. Mutually exclusive with inboxId.

inboxIdstring

Confine the operation to one inbox's policy. Mutually exclusive with podId.

Request body

mode'none' | 'allowlist' | 'inherit' required

none = no filtering; allowlist = only listed correspondents are permitted (empty allowlist denies all — fail closed); inherit = defer to the parent scope (pod, then account). Not valid at the account scope.

direction'inbound' | 'outbound'

inbound governs who may send to the inbox; outbound governs who the inbox may send to (enforced across To, Cc, Bcc, and Reply-To on every send path).

Response

The updated mode

object required

The updated mode

Changes

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