hornet icon

hornet

Interact with hornet API

Actions452

Quarantine Report → Quarantinereport Put

AI-generated

Summary

Update quarantine report settings for an object

Inputs

  • object_id — The ID of an object (user, customer, or partner). Sent as a query parameter.
  • mailbox_id — ID of a mailbox; used as a preferred selector when supplied together with object_id. Sent as a query parameter.
  • APP-ID (required) — Application identifier issued by Hornet Security. Sent as a header.
  • times (required) — Delivery times for the Quarantine Report (0‑23). Supplied as a JSON array in the request body.
  • days (required) — Delivery days for the Quarantine Report (0‑6, where 0 is Monday and 6 is Sunday). Supplied as a JSON array in the request body.
  • hide_blacklisted_senders — Hide emails marked as spam due to a deny‑list entry. Defaults to true.
  • report_address — Email address to which the report should be sent. Defaults to empty string.
  • template — Template to use for the spam report. Choices: default, default-preview, default-preview-denylist, wide, wide-preview-allowlist. Defaults to empty string.
  • allow_edit — Allow users to set their own Quarantine Report times. Defaults to true.
  • display_types — Email types to include in the report. Available types: 1 = spam, 5 = threat, 8 = content, 11 = info, 12 = advthreat. Supplied as a JSON array; defaults to [null].
  • hide_htmlcp_link — Whether to display a link to the control panel in the quarantine report. Defaults to true.
  • use_cp_qr — Flag to switch to the new quarantine report beta. Defaults to true.

Output shape

The operation returns the raw response from the Hornet API (typically a JSON object confirming the update).

Exact response shape depends on the API; refer to the Hornet API documentation for details.

Examples

Example 1: Set quarantine report for a user with ID 12345, using mailbox ID 67, delivering weekdays at 08:00 and 18:00.

object_id: 12345, mailbox_id: 67, times: [8,18], days: [1,2,3,4,5], APP-ID: <your‑app‑id>, report_address: admin@example.com, template: default, hide_blacklisted_senders: true, allow_edit: false, display_types: [1,5], hide_htmlcp_link: false, use_cp_qr: true

Links

Discussion