hornet icon

hornet

Interact with hornet API

Actions452

Compliance Filter → Compliance Filter Id Post

AI-generated

Summary

Posts a compliance filter rule for a given object (user/customer/partner) identified by Object Id, using the Hornet API.

Inputs

  • object_id (required) — The ID of an object (user, customer or partner). Sent as query parameter object_id.
  • id (required) — The ID of the compliance filter rule.
  • APP-ID (required) — App ID for authentication. Sent as HTTP header APP-ID.
  • direction — Direction of mail: 1 = INCOMING, 2 = OUTGOING. Sent in request body.
  • info — Description of the rule. Sent in request body.
  • size — Maximum mail size in MB (decimals beyond third ignored). Sent in request body.
  • action — Action to take: 1=REJECT,2=REDIRECT,3=REROUTE,4=BCC,5=IN_CLEAN,6=IN_QUAR,7=IN_VIRUS,8=OUT_NOTIFY. Sent in request body.
  • action_details — IP/hostname or semicolon-separated list of email addresses. Sent in request body.
  • priority — Priority of the rule (lower numbers higher priority). Sent in request body.
  • active — Whether the rule is active. Sent in request body.
  • criterion — Criterion type: 1=ADVANCED,2=HEADER,3=BODY. Sent in request body.
  • sender — Sender address to filter for (required if criterion=ADVANCED). Sent in request body.
  • receiver — Recipient address to filter for (required if criterion=ADVANCED). Sent in request body.
  • ip — IP address to filter for (required if criterion=ADVANCED). Sent in request body.
  • hostname — Hostname to filter for (required if criterion=ADVANCED). Sent in request body.
  • subject_contains — Subject text to filter for (required if criterion=ADVANCED). Sent in request body.
  • attachment_contains — Attachment name to filter for (required if criterion=ADVANCED). Sent in request body.
  • email_header_filter — Email header to filter for (required if criterion=HEADER). Sent in request body.
  • email_body_filter — Email body to filter for (required if criterion=BODY). Sent in request body.
  • recipients_amount — Maximum number of recipients allowed (required if criterion=ADVANCED). Sent in request body.
  • requestOptions — Additional HTTP request options (batching, SSL, proxy, timeout).

Output shape

object

The API response containing the created or updated compliance filter rule, as returned by the Hornet API.

Links

Discussion